mailslurp_client 12.7.1 → 12.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b30658f0733495cbe14304739a5e4d473c9fd1879fe04e77a1de08bebe1ebda
-  data.tar.gz: 36cbfd25f86f748c889e165a9f75d2ce4963d1a6321301893cc12a169529d533
+  metadata.gz: 0be4890f6575516d8fd55e9c1ecddec727214797175b97bc7a3640e854ab4efa
+  data.tar.gz: 5c4d1103dd95353d2a45b3c77082f53288f8d92949f81616406c854363bf31a8
 SHA512:
-  metadata.gz: a6e6578ddedee45fe6d211f754fcc382d4794e5fff8155c371159a73b685a911bd920def06aac75f36d3520b462dbcf29f26e5dac2c7b2897e340130804989e9
-  data.tar.gz: fccc3baccf13a1dc499b99f775110bd1cb40668fd89584f1bd00284ce7f2869bad7976f1b8660ce48b4ec050546b5a3fa7ac601e7eaf124a60b43e490dd9d960
+  metadata.gz: bbdedc8356a9c4c5a0fc3dfdc118aa80933f5682062412c2e967dea81b26862332eec13e39106d24a9dc40a0cb318647389aa669f9ea9af9f4e85aa87794859a
+  data.tar.gz: cbf43aff215df9400b093697d8f665b2e0c3d88ad6ab169c2fc2bcd774287bb16c00547a00a0ba4bbbbc8fdfea5650296518d73c12ea8c8879062509b69e0865

data/lib/mailslurp_client.rb

@@ -20,9 +20,14 @@ require 'mailslurp_client/configuration'
 require 'mailslurp_client/models/abstract_webhook_payload'
 require 'mailslurp_client/models/alias_dto'
 require 'mailslurp_client/models/alias_projection'
+require 'mailslurp_client/models/attachment_entity'
 require 'mailslurp_client/models/attachment_meta_data'
 require 'mailslurp_client/models/attachment_projection'
 require 'mailslurp_client/models/basic_auth_options'
+require 'mailslurp_client/models/bounce_projection'
+require 'mailslurp_client/models/bounce_recipient'
+require 'mailslurp_client/models/bounced_email_dto'
+require 'mailslurp_client/models/bounced_recipient_dto'
 require 'mailslurp_client/models/bulk_send_email_options'
 require 'mailslurp_client/models/condition_option'
 require 'mailslurp_client/models/contact_dto'
@@ -82,6 +87,8 @@ require 'mailslurp_client/models/name_server_record'
 require 'mailslurp_client/models/organization_inbox_projection'
 require 'mailslurp_client/models/page_alias'
 require 'mailslurp_client/models/page_attachment_entity'
+require 'mailslurp_client/models/page_bounced_email'
+require 'mailslurp_client/models/page_bounced_recipients'
 require 'mailslurp_client/models/page_contact_projection'
 require 'mailslurp_client/models/page_email_preview'
 require 'mailslurp_client/models/page_email_projection'
@@ -140,6 +147,7 @@ require 'mailslurp_client/models/webhook_test_result'
 # APIs
 require 'mailslurp_client/api/alias_controller_api'
 require 'mailslurp_client/api/attachment_controller_api'
+require 'mailslurp_client/api/bounce_controller_api'
 require 'mailslurp_client/api/bulk_actions_controller_api'
 require 'mailslurp_client/api/common_actions_controller_api'
 require 'mailslurp_client/api/contact_controller_api'

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -19,6 +19,58 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Delete all attachments
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_all_attachments(opts = {})
+      delete_all_attachments_with_http_info(opts)
+      nil
+    end
+
+    # Delete all attachments
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_all_attachments_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.delete_all_attachments ...'
+      end
+      # resource path
+      local_var_path = '/attachments'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # 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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentControllerApi#delete_all_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete an attachment
     # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param attachment_id [String] ID of attachment
@@ -203,6 +255,68 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get an attachment entity
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [AttachmentEntity]
+    def get_attachment(attachment_id, opts = {})
+      data, _status_code, _headers = get_attachment_with_http_info(attachment_id, opts)
+      data
+    end
+
+    # Get an attachment entity
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with &#x60;SendEmailOptions&#x60; when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # @param attachment_id [String] ID of attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AttachmentEntity, Integer, Hash)>] AttachmentEntity data, response status code and response headers
+    def get_attachment_with_http_info(attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentControllerApi.get_attachment ...'
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentControllerApi.get_attachment"
+      end
+      # resource path
+      local_var_path = '/attachments/{attachmentId}'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
+
+      # 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] || 'AttachmentEntity' 
+
+      # 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: AttachmentControllerApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get email attachment metadata information
     # Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.
     # @param attachment_id [String] ID of attachment
@@ -404,7 +518,7 @@ module MailSlurpClient
     # Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
     # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :string Optional contentType for file. For instance &#x60;application/pdf&#x60;
+    # @option opts [String] :content_type Optional contentType for file. For instance &#x60;application/pdf&#x60;
     # @option opts [String] :filename Optional filename to save upload with
     # @option opts [String] :byte_array Byte array request body
     # @return [Array<String>]
@@ -416,7 +530,7 @@ module MailSlurpClient
     # Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
     # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with &#x60;SendEmailOptions&#x60; when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :string Optional contentType for file. For instance &#x60;application/pdf&#x60;
+    # @option opts [String] :content_type Optional contentType for file. For instance &#x60;application/pdf&#x60;
     # @option opts [String] :filename Optional filename to save upload with
     # @option opts [String] :byte_array Byte array request body
     # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
@@ -429,7 +543,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'String'] = opts[:'string'] if !opts[:'string'].nil?
+      query_params[:'contentType'] = opts[:'content_type'] if !opts[:'content_type'].nil?
       query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?
 
       # header parameters

data/lib/mailslurp_client/api/bounce_controller_api.rb

@@ -0,0 +1,284 @@
+=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 'cgi'
+
+module MailSlurpClient
+  class BounceControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get a bounced email.
+    # Bounced emails are email you have sent that were rejected by a recipient
+    # @param id [String] ID of the bounced email to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [BouncedEmailDto]
+    def get_bounced_email(id, opts = {})
+      data, _status_code, _headers = get_bounced_email_with_http_info(id, opts)
+      data
+    end
+
+    # Get a bounced email.
+    # Bounced emails are email you have sent that were rejected by a recipient
+    # @param id [String] ID of the bounced email to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BouncedEmailDto, Integer, Hash)>] BouncedEmailDto data, response status code and response headers
+    def get_bounced_email_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BounceControllerApi.get_bounced_email ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BounceControllerApi.get_bounced_email"
+      end
+      # resource path
+      local_var_path = '/bounce/emails/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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] || 'BouncedEmailDto' 
+
+      # 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: BounceControllerApi#get_bounced_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get paginated list of bounced emails.
+    # Bounced emails are email you have sent that were rejected by a recipient
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index  (default to 0)
+    # @option opts [Integer] :size Optional page size  (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageBouncedEmail]
+    def get_bounced_emails(opts = {})
+      data, _status_code, _headers = get_bounced_emails_with_http_info(opts)
+      data
+    end
+
+    # Get paginated list of bounced emails.
+    # Bounced emails are email you have sent that were rejected by a recipient
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index 
+    # @option opts [Integer] :size Optional page size 
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageBouncedEmail, Integer, Hash)>] PageBouncedEmail data, response status code and response headers
+    def get_bounced_emails_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BounceControllerApi.get_bounced_emails ...'
+      end
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/bounce/emails'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # 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] || 'PageBouncedEmail' 
+
+      # 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: BounceControllerApi#get_bounced_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a bounced email.
+    # Bounced emails are email you have sent that were rejected by a recipient
+    # @param id [String] ID of the bounced recipient
+    # @param [Hash] opts the optional parameters
+    # @return [BouncedRecipientDto]
+    def get_bounced_recipient(id, opts = {})
+      data, _status_code, _headers = get_bounced_recipient_with_http_info(id, opts)
+      data
+    end
+
+    # Get a bounced email.
+    # Bounced emails are email you have sent that were rejected by a recipient
+    # @param id [String] ID of the bounced recipient
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BouncedRecipientDto, Integer, Hash)>] BouncedRecipientDto data, response status code and response headers
+    def get_bounced_recipient_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BounceControllerApi.get_bounced_recipient ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BounceControllerApi.get_bounced_recipient"
+      end
+      # resource path
+      local_var_path = '/bounce/recipients/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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] || 'BouncedRecipientDto' 
+
+      # 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: BounceControllerApi#get_bounced_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get paginated list of bounced recipients.
+    # Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index  (default to 0)
+    # @option opts [Integer] :size Optional page size  (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageBouncedRecipients]
+    def get_bounced_recipients(opts = {})
+      data, _status_code, _headers = get_bounced_recipients_with_http_info(opts)
+      data
+    end
+
+    # Get paginated list of bounced recipients.
+    # Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index 
+    # @option opts [Integer] :size Optional page size 
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageBouncedRecipients, Integer, Hash)>] PageBouncedRecipients data, response status code and response headers
+    def get_bounced_recipients_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BounceControllerApi.get_bounced_recipients ...'
+      end
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/bounce/recipients'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # 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] || 'PageBouncedRecipients' 
+
+      # 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: BounceControllerApi#get_bounced_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end