mailslurp_client 11.8.10 → 11.9.1

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -19,7 +19,7 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create an Inbox (email address)
+    # Create an inbox email address. An inbox has a real email address and can send and receive emails.
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
@@ -37,7 +37,7 @@ module MailSlurpClient
       data
     end
 
-    # Create an Inbox (email address)
+    # Create an inbox email address. An inbox has a real email address and can send and receive emails.
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
@@ -102,7 +102,61 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Create an inbox with additional options
+    # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
+    # @param [Hash] opts the optional parameters
+    # @return [Inbox]
+    def create_inbox_with_defaults(opts = {})
+      data, _status_code, _headers = create_inbox_with_defaults_with_http_info(opts)
+      data
+    end
+
+    # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
+    def create_inbox_with_defaults_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_defaults ...'
+      end
+      # resource path
+      local_var_path = '/inboxes/withDefaults'
+
+      # 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] || 'Inbox' 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxControllerApi#create_inbox_with_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an inbox with options. Extended options for inbox creation.
     # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
     # @param create_inbox_dto [CreateInboxDto] createInboxDto
     # @param [Hash] opts the optional parameters
@@ -112,7 +166,7 @@ module MailSlurpClient
       data
     end
 
-    # Create an inbox with additional options
+    # Create an inbox with options. Extended options for inbox creation.
     # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
     # @param create_inbox_dto [CreateInboxDto] createInboxDto
     # @param [Hash] opts the optional parameters
@@ -445,7 +499,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get Inbox
+    # Get Inbox. Returns properties of an inbox.
     # Returns an inbox's properties, including its email address and ID.
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
@@ -455,7 +509,7 @@ module MailSlurpClient
       data
     end
 
-    # Get Inbox
+    # Get Inbox. Returns properties of an inbox.
     # Returns an inbox&#39;s properties, including its email address and ID.
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
@@ -713,7 +767,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # List Inboxes / Email Addresses
+    # List Inboxes and email eddresses
     # List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
@@ -724,7 +778,7 @@ module MailSlurpClient
       data
     end
 
-    # List Inboxes / Email Addresses
+    # List Inboxes and email eddresses
     # List the inboxes you have created. Note use of the more advanced &#x60;getAllEmails&#x60; is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
@@ -913,7 +967,7 @@ module MailSlurpClient
     end
 
     # Send email and return sent confirmation
-    # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
+    # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
     # @param inbox_id [String] ID of the inbox you want to send the email from
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email
@@ -924,7 +978,7 @@ module MailSlurpClient
     end
 
     # Send email and return sent confirmation
-    # Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with link the the sent object created for it.
+    # Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with a link to the sent object created for it.
     # @param inbox_id [String] ID of the inbox you want to send the email from
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email
@@ -1048,7 +1102,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Update Inbox
+    # Update Inbox. Change name and description. Email address is not editable.
     # Update editable fields on an inbox
     # @param inbox_id [String] inboxId
     # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions
@@ -1059,7 +1113,7 @@ module MailSlurpClient
       data
     end
 
-    # Update Inbox
+    # Update Inbox. Change name and description. Email address is not editable.
     # Update editable fields on an inbox
     # @param inbox_id [String] inboxId
     # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions

data/lib/mailslurp_client/api/wait_for_controller_api.rb

@@ -19,20 +19,20 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Wait for conditions to be met
+    # Wait for an email to match the provided filter conditions such as subject contains keyword.
     # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
     # @param [Hash] opts the optional parameters
-    # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
+    # @option opts [WaitForConditions] :wait_for_conditions Conditions to apply to emails that you are waiting for
     # @return [Array<EmailPreview>]
     def wait_for(opts = {})
       data, _status_code, _headers = wait_for_with_http_info(opts)
       data
     end
 
-    # Wait for conditions to be met
+    # Wait for an email to match the provided filter conditions such as subject contains keyword.
     # Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
     # @param [Hash] opts the optional parameters
-    # @option opts [WaitForConditions] :wait_for_conditions Conditions to wait for
+    # @option opts [WaitForConditions] :wait_for_conditions Conditions to apply to emails that you are waiting for
     # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
     def wait_for_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -79,7 +79,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Wait for and return count number of emails 
+    # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
     # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
@@ -92,7 +92,7 @@ module MailSlurpClient
       data
     end
 
-    # Wait for and return count number of emails 
+    # Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
     # If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
@@ -361,7 +361,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Wait for or fetch the email with a given index in the inbox specified
+    # Wait for or fetch the email with a given index in the inbox specified. IF indx doesn't exist waits for it to exist or timeout to occur.
     # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Id of the inbox you are fetching emails from
@@ -374,7 +374,7 @@ module MailSlurpClient
       data
     end
 
-    # Wait for or fetch the email with a given index in the inbox specified
+    # Wait for or fetch the email with a given index in the inbox specified. IF indx doesn&#39;t exist waits for it to exist or timeout to occur.
     # If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Id of the inbox you are fetching emails from

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/attachment_meta_data.rb

@@ -18,13 +18,13 @@ module MailSlurpClient
     # Size of attachment in bytes
     attr_accessor :content_length
 
-    # Content type of attachment
+    # Content type of attachment such as `image/png`
     attr_accessor :content_type
 
     # ID of attachment
     attr_accessor :id
 
-    # Name of attachment
+    # Name of attachment if given
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/create_domain_options.rb

@@ -24,12 +24,38 @@ module MailSlurpClient
     # The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
     attr_accessor :domain
 
+    # Domain type to create. HTTP or SMTP domain. HTTP domain uses MailSlurps SES MX records. SMTP uses a custom SMTP server MX record
+    attr_accessor :domain_type
+
+    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
       {
         :'created_catch_all_inbox' => :'createdCatchAllInbox',
         :'description' => :'description',
-        :'domain' => :'domain'
+        :'domain' => :'domain',
+        :'domain_type' => :'domainType'
       }
     end
 
@@ -38,7 +64,8 @@ module MailSlurpClient
       {
         :'created_catch_all_inbox' => :'Boolean',
         :'description' => :'String',
-        :'domain' => :'String'
+        :'domain' => :'String',
+        :'domain_type' => :'String'
       }
     end
 
@@ -74,6 +101,10 @@ module MailSlurpClient
       if attributes.key?(:'domain')
         self.domain = attributes[:'domain']
       end
+
+      if attributes.key?(:'domain_type')
+        self.domain_type = attributes[:'domain_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -86,9 +117,21 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      domain_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
+      return false unless domain_type_validator.valid?(@domain_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] domain_type Object to be assigned
+    def domain_type=(domain_type)
+      validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
+      unless validator.valid?(domain_type)
+        fail ArgumentError, "invalid value for \"domain_type\", must be one of #{validator.allowable_values}."
+      end
+      @domain_type = domain_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -96,7 +139,8 @@ module MailSlurpClient
       self.class == o.class &&
           created_catch_all_inbox == o.created_catch_all_inbox &&
           description == o.description &&
-          domain == o.domain
+          domain == o.domain &&
+          domain_type == o.domain_type
     end
 
     # @see the `==` method
@@ -108,7 +152,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_catch_all_inbox, description, domain].hash
+      [created_catch_all_inbox, description, domain, domain_type].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -33,6 +33,9 @@ module MailSlurpClient
     # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
     attr_accessor :favourite
 
+    # HTTP or SMTP inbox
+    attr_accessor :inbox_type
+
     # Optional name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
@@ -42,6 +45,28 @@ module MailSlurpClient
     # Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field.
     attr_accessor :use_domain_pool
 
+    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
       {
@@ -51,6 +76,7 @@ module MailSlurpClient
         :'expires_at' => :'expiresAt',
         :'expires_in' => :'expiresIn',
         :'favourite' => :'favourite',
+        :'inbox_type' => :'inboxType',
         :'name' => :'name',
         :'tags' => :'tags',
         :'use_domain_pool' => :'useDomainPool'
@@ -66,6 +92,7 @@ module MailSlurpClient
         :'expires_at' => :'DateTime',
         :'expires_in' => :'Integer',
         :'favourite' => :'Boolean',
+        :'inbox_type' => :'String',
         :'name' => :'String',
         :'tags' => :'Array<String>',
         :'use_domain_pool' => :'Boolean'
@@ -117,6 +144,10 @@ module MailSlurpClient
         self.favourite = attributes[:'favourite']
       end
 
+      if attributes.key?(:'inbox_type')
+        self.inbox_type = attributes[:'inbox_type']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -142,9 +173,21 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
+      return false unless inbox_type_validator.valid?(@inbox_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] inbox_type Object to be assigned
+    def inbox_type=(inbox_type)
+      validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
+      unless validator.valid?(inbox_type)
+        fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{validator.allowable_values}."
+      end
+      @inbox_type = inbox_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -156,6 +199,7 @@ module MailSlurpClient
           expires_at == o.expires_at &&
           expires_in == o.expires_in &&
           favourite == o.favourite &&
+          inbox_type == o.inbox_type &&
           name == o.name &&
           tags == o.tags &&
           use_domain_pool == o.use_domain_pool
@@ -170,7 +214,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allow_team_access, description, email_address, expires_at, expires_in, favourite, name, tags, use_domain_pool].hash
+      [allow_team_access, description, email_address, expires_at, expires_in, favourite, inbox_type, name, tags, use_domain_pool].hash
     end
 
     # Builds the object from hash