mailslurp_client 12.1.1 → 12.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26d71dcbba0c71c4f1887b4b310766b50c5960a0f94f2fcd3c99ff7fc717fb93
-  data.tar.gz: 3ef52e97f70aa606f43040d4f0a96b8b7d37a9d26930e037f717298187ccd667
+  metadata.gz: 0ce5e946602bce43bfa765ba18ecfb0013758144d239b4b2757a86b7ed386007
+  data.tar.gz: 354b19f8892498e8e43e3287e00ba8a51d89ddf6429382f4347c2f71b3da17e5
 SHA512:
-  metadata.gz: 108460f9d2090917d2aa9ae56a1e11519c59e789906bb8b61fd5d4198e85a9673ec5ce7cd6ba7d42e5449be62f0df86ec63abd6cd2cceaf3f84cb839d5512d72
-  data.tar.gz: 55e1110b31561de24227c60bd694f6f1d0da8f431af3585c58700405866a5aefbfb1cae973b2779bb257b83e598ed3d258aa50a1063c16f0b3ebe52b2a9cad85
+  metadata.gz: ec56cdecb557898fff2d558a926e3cde6991571bacafb49bb0c2918a2c066876dc143b2085908a4d7e6469591d9cd31e77d1fe9df816fbd49a78df2e43f725e3
+  data.tar.gz: 027a781268f7d49c8eeb6718032d0449922c9bb571cc7d7c3c6cf24bb10c66af64e456c41ffd21cac70be5ee9005435749c2f60b4522ddd8e6dd03128db43674

data/lib/mailslurp_client.rb

@@ -24,6 +24,7 @@ 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/condition_option'
 require 'mailslurp_client/models/contact_dto'
 require 'mailslurp_client/models/contact_projection'
 require 'mailslurp_client/models/content_match_options'
@@ -107,6 +108,9 @@ 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_new_attachment_payload'
+require 'mailslurp_client/models/webhook_new_contact_payload'
+require 'mailslurp_client/models/webhook_new_email_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/wait_for_controller_api.rb

@@ -288,7 +288,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Wait for or return the first email that matches proved MatchOptions array
+    # Wait for or return the first email that matches provided MatchOptions array
     # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
@@ -301,7 +301,7 @@ module MailSlurpClient
       data
     end
 
-    # Wait for or return the first email that matches proved MatchOptions array
+    # Wait for or return the first email that matches provided MatchOptions array
     # Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/api/webhook_controller_api.rb

@@ -283,6 +283,168 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get webhook test payload for new attachment event
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookNewAttachmentPayload]
+    def get_test_webhook_payload_new_attachment(opts = {})
+      data, _status_code, _headers = get_test_webhook_payload_new_attachment_with_http_info(opts)
+      data
+    end
+
+    # Get webhook test payload for new attachment event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookNewAttachmentPayload, Integer, Hash)>] WebhookNewAttachmentPayload data, response status code and response headers
+    def get_test_webhook_payload_new_attachment_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_test_webhook_payload_new_attachment ...'
+      end
+      # resource path
+      local_var_path = '/webhooks/test/new-attachment-payload'
+
+      # 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] || 'WebhookNewAttachmentPayload' 
+
+      # 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_new_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get webhook test payload for new contact event
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookNewContactPayload]
+    def get_test_webhook_payload_new_contact(opts = {})
+      data, _status_code, _headers = get_test_webhook_payload_new_contact_with_http_info(opts)
+      data
+    end
+
+    # Get webhook test payload for new contact event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookNewContactPayload, Integer, Hash)>] WebhookNewContactPayload data, response status code and response headers
+    def get_test_webhook_payload_new_contact_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_test_webhook_payload_new_contact ...'
+      end
+      # resource path
+      local_var_path = '/webhooks/test/new-contact-payload'
+
+      # 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] || 'WebhookNewContactPayload' 
+
+      # 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_new_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get webhook test payload for new email event
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookNewEmailPayload]
+    def get_test_webhook_payload_new_email(opts = {})
+      data, _status_code, _headers = get_test_webhook_payload_new_email_with_http_info(opts)
+      data
+    end
+
+    # Get webhook test payload for new email event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookNewEmailPayload, Integer, Hash)>] WebhookNewEmailPayload data, response status code and response headers
+    def get_test_webhook_payload_new_email_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_test_webhook_payload_new_email ...'
+      end
+      # resource path
+      local_var_path = '/webhooks/test/new-email-payload'
+
+      # 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] || 'WebhookNewEmailPayload' 
+
+      # 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_new_email\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

data/lib/mailslurp_client/models/abstract_webhook_payload.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the `NEW_EMAIL`,`NEW_CONTACT` and `NEW_ATTACHMENT` payloads for the properties available for those events.
   class AbstractWebhookPayload
     attr_accessor :event_name
 

data/lib/mailslurp_client/models/condition_option.rb

@@ -0,0 +1,264 @@
+=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
+  # Options for matching emails in an inbox based on a condition such as `HAS_ATTACHMENTS=TRUE`
+  class ConditionOption
+    # The condition to evaluate against the email
+    attr_accessor :condition
+
+    # What the condition should evaluate to. A string 'TRUE|FALSE' not a boolean.
+    attr_accessor :value
+
+    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
+      {
+        :'condition' => :'condition',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'condition' => :'String',
+        :'value' => :'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::ConditionOption` 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::ConditionOption`. 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?(:'condition')
+        self.condition = attributes[:'condition']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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?
+      condition_validator = EnumAttributeValidator.new('String', ["HAS_ATTACHMENTS"])
+      return false unless condition_validator.valid?(@condition)
+      value_validator = EnumAttributeValidator.new('String', ["TRUE", "FALSE"])
+      return false unless value_validator.valid?(@value)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] condition Object to be assigned
+    def condition=(condition)
+      validator = EnumAttributeValidator.new('String', ["HAS_ATTACHMENTS"])
+      unless validator.valid?(condition)
+        fail ArgumentError, "invalid value for \"condition\", must be one of #{validator.allowable_values}."
+      end
+      @condition = condition
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] value Object to be assigned
+    def value=(value)
+      validator = EnumAttributeValidator.new('String', ["TRUE", "FALSE"])
+      unless validator.valid?(value)
+        fail ArgumentError, "invalid value for \"value\", must be one of #{validator.allowable_values}."
+      end
+      @value = value
+    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 &&
+          condition == o.condition &&
+          value == o.value
+    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
+      [condition, value].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