mailslurp_client 5.0.0 → 7.0.7

data/lib/mailslurp_client/api/domain_controller_api.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: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module MailSlurpClient
+  class DomainControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Domain
+    # Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
+    # @param domain_options [CreateDomainOptions] domainOptions
+    # @param [Hash] opts the optional parameters
+    # @return [DomainDto]
+    def create_domain(domain_options, opts = {})
+      data, _status_code, _headers = create_domain_with_http_info(domain_options, opts)
+      data
+    end
+
+    # Create Domain
+    # Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
+    # @param domain_options [CreateDomainOptions] domainOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
+    def create_domain_with_http_info(domain_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainControllerApi.create_domain ...'
+      end
+      # verify the required parameter 'domain_options' is set
+      if @api_client.config.client_side_validation && domain_options.nil?
+        fail ArgumentError, "Missing the required parameter 'domain_options' when calling DomainControllerApi.create_domain"
+      end
+      # resource path
+      local_var_path = '/domains'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(domain_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'DomainDto' 
+
+      # 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: DomainControllerApi#create_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a domain
+    # Delete a domain. This will disable any existing inboxes that use this domain.
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_domain(id, opts = {})
+      delete_domain_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete a domain
+    # Delete a domain. This will disable any existing inboxes that use this domain.
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_domain_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainControllerApi.delete_domain ...'
+      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 DomainControllerApi.delete_domain"
+      end
+      # resource path
+      local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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: DomainControllerApi#delete_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a domain
+    # Returns domain verification status and tokens for a given domain
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @return [DomainDto]
+    def get_domain(id, opts = {})
+      data, _status_code, _headers = get_domain_with_http_info(id, opts)
+      data
+    end
+
+    # Get a domain
+    # Returns domain verification status and tokens for a given domain
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
+    def get_domain_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainControllerApi.get_domain ...'
+      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 DomainControllerApi.get_domain"
+      end
+      # resource path
+      local_var_path = '/domains/{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] || 'DomainDto' 
+
+      # 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: DomainControllerApi#get_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get domains
+    # List all custom domains you have created
+    # @param [Hash] opts the optional parameters
+    # @return [Array<DomainPreview>]
+    def get_domains(opts = {})
+      data, _status_code, _headers = get_domains_with_http_info(opts)
+      data
+    end
+
+    # Get domains
+    # List all custom domains you have created
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<DomainPreview>, Integer, Hash)>] Array<DomainPreview> data, response status code and response headers
+    def get_domains_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainControllerApi.get_domains ...'
+      end
+      # resource path
+      local_var_path = '/domains'
+
+      # 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] || 'Array<DomainPreview>' 
+
+      # 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: DomainControllerApi#get_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -0,0 +1,852 @@
+=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: 67c9a1eda264be4cfe0bb2c76151f0aadf0862bc
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module MailSlurpClient
+  class EmailControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete all emails
+    # Deletes all emails in your account. Be careful as emails cannot be recovered
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_all_emails(opts = {})
+      delete_all_emails_with_http_info(opts)
+      nil
+    end
+
+    # Delete all emails
+    # Deletes all emails in your account. Be careful as emails cannot be recovered
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_all_emails_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.delete_all_emails ...'
+      end
+      # resource path
+      local_var_path = '/emails'
+
+      # 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: EmailControllerApi#delete_all_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an email
+    # Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_email(email_id, opts = {})
+      delete_email_with_http_info(email_id, opts)
+      nil
+    end
+
+    # Delete an email
+    # Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_email_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.delete_email ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.delete_email"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+
+      # 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: EmailControllerApi#delete_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get email attachment bytes
+    # Returns the specified attachment for a given email as a byte stream (file download). You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # @param attachment_id [String] attachmentId
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :api_key Can pass apiKey in url for this request if you wish to download the file in a browser
+    # @return [String]
+    def download_attachment(attachment_id, email_id, opts = {})
+      data, _status_code, _headers = download_attachment_with_http_info(attachment_id, email_id, opts)
+      data
+    end
+
+    # Get email attachment bytes
+    # Returns the specified attachment for a given email as a byte stream (file download). You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+    # @param attachment_id [String] attachmentId
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :api_key Can pass apiKey in url for this request if you wish to download the file in a browser
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def download_attachment_with_http_info(attachment_id, email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.download_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 EmailControllerApi.download_attachment"
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.download_attachment"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/attachments/{attachmentId}'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s)).sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'apiKey'] = opts[:'api_key'] if !opts[:'api_key'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'String' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailControllerApi#download_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Forward email
+    # Forward an existing email to new recipients.
+    # @param email_id [String] emailId
+    # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def forward_email(email_id, forward_email_options, opts = {})
+      forward_email_with_http_info(email_id, forward_email_options, opts)
+      nil
+    end
+
+    # Forward email
+    # Forward an existing email to new recipients.
+    # @param email_id [String] emailId
+    # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def forward_email_with_http_info(email_id, forward_email_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.forward_email ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.forward_email"
+      end
+      # verify the required parameter 'forward_email_options' is set
+      if @api_client.config.client_side_validation && forward_email_options.nil?
+        fail ArgumentError, "Missing the required parameter 'forward_email_options' when calling EmailControllerApi.forward_email"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/forward'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(forward_email_options) 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailControllerApi#forward_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get email attachment metadata
+    # Returns the metadata such as name and content-type for a given attachment and email.
+    # @param attachment_id [String] attachmentId
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [AttachmentMetaData]
+    def get_attachment_meta_data(attachment_id, email_id, opts = {})
+      data, _status_code, _headers = get_attachment_meta_data_with_http_info(attachment_id, email_id, opts)
+      data
+    end
+
+    # Get email attachment metadata
+    # Returns the metadata such as name and content-type for a given attachment and email.
+    # @param attachment_id [String] attachmentId
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AttachmentMetaData, Integer, Hash)>] AttachmentMetaData data, response status code and response headers
+    def get_attachment_meta_data_with_http_info(attachment_id, email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_attachment_meta_data ...'
+      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 EmailControllerApi.get_attachment_meta_data"
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_attachment_meta_data"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/attachments/{attachmentId}/metadata'.sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s)).sub('{' + 'emailId' + '}', CGI.escape(email_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] || 'AttachmentMetaData' 
+
+      # 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: EmailControllerApi#get_attachment_meta_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all email attachment metadata
+    # Returns an array of attachment metadata such as name and content-type for a given email if present.
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AttachmentMetaData>]
+    def get_attachments(email_id, opts = {})
+      data, _status_code, _headers = get_attachments_with_http_info(email_id, opts)
+      data
+    end
+
+    # Get all email attachment metadata
+    # Returns an array of attachment metadata such as name and content-type for a given email if present.
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AttachmentMetaData>, Integer, Hash)>] Array<AttachmentMetaData> data, response status code and response headers
+    def get_attachments_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_attachments ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_attachments"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/attachments'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || 'Array<AttachmentMetaData>' 
+
+      # 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: EmailControllerApi#get_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get email content
+    # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance &#x60;&#x3D;D7&#x60;). This can be a pain for testing (default to false)
+    # @return [Email]
+    def get_email(email_id, opts = {})
+      data, _status_code, _headers = get_email_with_http_info(email_id, opts)
+      data
+    end
+
+    # Get email content
+    # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance &#x60;&#x3D;D7&#x60;). This can be a pain for testing
+    # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
+    def get_email_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].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] || 'Email' 
+
+      # 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: EmailControllerApi#get_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get email content as HTML
+    # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode decode (default to false)
+    # @return [String]
+    def get_email_html(email_id, opts = {})
+      data, _status_code, _headers = get_email_html_with_http_info(email_id, opts)
+      data
+    end
+
+    # Get email content as HTML
+    # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: &#x60;?apiKey&#x3D;xxx&#x60;
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode decode
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def get_email_html_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_html"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/html'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/html'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'String' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailControllerApi#get_email_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all emails
+    # 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.
+    # @option opts [Integer] :page Optional page index in email list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in email list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (default to false)
+    # @return [PageEmailProjection]
+    def get_emails_paginated(opts = {})
+      data, _status_code, _headers = get_emails_paginated_with_http_info(opts)
+      data
+    end
+
+    # Get all emails
+    # 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.
+    # @option opts [Integer] :page Optional page index in email list pagination
+    # @option opts [Integer] :size Optional page size in email list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
+    # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers
+    def get_emails_paginated_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_emails_paginated ...'
+      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 = '/emails'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = @api_client.build_collection_param(opts[:'inbox_id'], :multi) if !opts[:'inbox_id'].nil?
+      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?
+      query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].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] || 'PageEmailProjection' 
+
+      # 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: EmailControllerApi#get_emails_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get raw email string
+    # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_raw_email_contents(email_id, opts = {})
+      data, _status_code, _headers = get_raw_email_contents_with_http_info(email_id, opts)
+      data
+    end
+
+    # Get raw email string
+    # Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def get_raw_email_contents_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_raw_email_contents ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_raw_email_contents"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/raw'.sub('{' + 'emailId' + '}', CGI.escape(email_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(['text/plain'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'String' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailControllerApi#get_raw_email_contents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get raw email in JSON
+    # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [RawEmailJson]
+    def get_raw_email_json(email_id, opts = {})
+      data, _status_code, _headers = get_raw_email_json_with_http_info(email_id, opts)
+      data
+    end
+
+    # Get raw email in JSON
+    # Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RawEmailJson, Integer, Hash)>] RawEmailJson data, response status code and response headers
+    def get_raw_email_json_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_raw_email_json ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_raw_email_json"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/raw/json'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || 'RawEmailJson' 
+
+      # 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: EmailControllerApi#get_raw_email_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get unread email count
+    # Get number of emails unread
+    # @param [Hash] opts the optional parameters
+    # @return [UnreadCount]
+    def get_unread_email_count(opts = {})
+      data, _status_code, _headers = get_unread_email_count_with_http_info(opts)
+      data
+    end
+
+    # Get unread email count
+    # Get number of emails unread
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_unread_email_count ...'
+      end
+      # resource path
+      local_var_path = '/emails/unreadCount'
+
+      # 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] || 'UnreadCount' 
+
+      # 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: EmailControllerApi#get_unread_email_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Validate email
+    # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [ValidationDto]
+    def validate_email(email_id, opts = {})
+      data, _status_code, _headers = validate_email_with_http_info(email_id, opts)
+      data
+    end
+
+    # Validate email
+    # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
+    # @param email_id [String] emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidationDto, Integer, Hash)>] ValidationDto data, response status code and response headers
+    def validate_email_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.validate_email ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.validate_email"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/validate'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || 'ValidationDto' 
+
+      # 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: EmailControllerApi#validate_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end