mailslurp_client 11.1.0 → 11.4.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4cffc3d4ad26c6083619d2b55319d076433419ba6ab9191aafc722c667845b3
-  data.tar.gz: 262f90db6488aea3d4d8447da81bac53f44236dbc427728218ee5c91bfcb1120
+  metadata.gz: aef4b7af2f3f59476edbe6983d41622f285dd6302fe524e91fb27c399a6f242d
+  data.tar.gz: e78c4a6d1921170ea4afd60c994e4734e02f48894b7f34e66eb9665315d6f2b4
 SHA512:
-  metadata.gz: 625752091e51d5c99781c83b72949a817282e9a5d8f0d7445221fa4427ccf50567bfc7de87928af346623d6096d577a9104ab1c0e81ad112d64047e1ba599160
-  data.tar.gz: 821885d3019eaa556822ded8ecb2f5d9365e360d22a4da426961dc68d4b5572be3786a676045d37dae447a7420724f1cdfa7bd893b179e0fe711d7ecaa3a5700
+  metadata.gz: 1a015ae37ee22012ddebfdf16849e47ae48dddaa4e385ea6ae50796e06b8e560d9fb6e7e83df968bef09c9134886b98dbed32130b6bf98ec09c5948208258a19
+  data.tar.gz: 98e8012e2189181ca3f4fe544c158c08aadfcfc4b8b345d7cd14d2950a118232af1da6de92bb648169553b460b5e9724affdb754198a3bed1dcc5c9e434fd829

data/lib/mailslurp_client.rb

@@ -48,6 +48,7 @@ require 'mailslurp_client/models/email_preview'
 require 'mailslurp_client/models/email_projection'
 require 'mailslurp_client/models/email_text_lines_result'
 require 'mailslurp_client/models/email_verification_result'
+require 'mailslurp_client/models/expiration_defaults'
 require 'mailslurp_client/models/expired_inbox_dto'
 require 'mailslurp_client/models/expired_inbox_record_projection'
 require 'mailslurp_client/models/forward_email_options'
@@ -89,6 +90,7 @@ require 'mailslurp_client/models/template_variable'
 require 'mailslurp_client/models/thread_projection'
 require 'mailslurp_client/models/unread_count'
 require 'mailslurp_client/models/update_alias_options'
+require 'mailslurp_client/models/update_domain_options'
 require 'mailslurp_client/models/update_group_contacts'
 require 'mailslurp_client/models/update_inbox_options'
 require 'mailslurp_client/models/upload_attachment_options'
@@ -110,6 +112,7 @@ require 'mailslurp_client/api/common_actions_controller_api'
 require 'mailslurp_client/api/contact_controller_api'
 require 'mailslurp_client/api/domain_controller_api'
 require 'mailslurp_client/api/email_controller_api'
+require 'mailslurp_client/api/expired_controller_api'
 require 'mailslurp_client/api/form_controller_api'
 require 'mailslurp_client/api/group_controller_api'
 require 'mailslurp_client/api/inbox_controller_api'

data/lib/mailslurp_client/api/domain_controller_api.rb

@@ -19,6 +19,68 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Add catch all wild card inbox to domain
+    # Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @return [DomainDto]
+    def add_domain_wildcard_catch_all(id, opts = {})
+      data, _status_code, _headers = add_domain_wildcard_catch_all_with_http_info(id, opts)
+      data
+    end
+
+    # Add catch all wild card inbox to domain
+    # Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
+    def add_domain_wildcard_catch_all_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainControllerApi.add_domain_wildcard_catch_all ...'
+      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.add_domain_wildcard_catch_all"
+      end
+      # resource path
+      local_var_path = '/domains/{id}/wildcard'.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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainControllerApi#add_domain_wildcard_catch_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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
@@ -262,5 +324,75 @@ module MailSlurpClient
       end
       return data, status_code, headers
     end
+
+    # Update a domain
+    # Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.
+    # @param id [String] id
+    # @param update_domain_dto [UpdateDomainOptions] updateDomainDto
+    # @param [Hash] opts the optional parameters
+    # @return [DomainDto]
+    def update_domain(id, update_domain_dto, opts = {})
+      data, _status_code, _headers = update_domain_with_http_info(id, update_domain_dto, opts)
+      data
+    end
+
+    # Update a domain
+    # Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.
+    # @param id [String] id
+    # @param update_domain_dto [UpdateDomainOptions] updateDomainDto
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DomainDto, Integer, Hash)>] DomainDto data, response status code and response headers
+    def update_domain_with_http_info(id, update_domain_dto, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainControllerApi.update_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.update_domain"
+      end
+      # verify the required parameter 'update_domain_dto' is set
+      if @api_client.config.client_side_validation && update_domain_dto.nil?
+        fail ArgumentError, "Missing the required parameter 'update_domain_dto' when calling DomainControllerApi.update_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'])
+      # 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(update_domain_dto) 
+
+      # 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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainControllerApi#update_domain\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

@@ -673,21 +673,21 @@ module MailSlurpClient
     # Parse and return text from an email, stripping HTML and decoding encoded characters
     # Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
     # @param email_id [String] ID of email to perform HTML query on
-    # @param html_selector [String] HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :html_selector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
     # @return [EmailTextLinesResult]
-    def get_email_html_query(email_id, html_selector, opts = {})
-      data, _status_code, _headers = get_email_html_query_with_http_info(email_id, html_selector, opts)
+    def get_email_html_query(email_id, opts = {})
+      data, _status_code, _headers = get_email_html_query_with_http_info(email_id, opts)
       data
     end
 
     # Parse and return text from an email, stripping HTML and decoding encoded characters
     # Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
     # @param email_id [String] ID of email to perform HTML query on
-    # @param html_selector [String] HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :html_selector HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
     # @return [Array<(EmailTextLinesResult, Integer, Hash)>] EmailTextLinesResult data, response status code and response headers
-    def get_email_html_query_with_http_info(email_id, html_selector, opts = {})
+    def get_email_html_query_with_http_info(email_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html_query ...'
       end
@@ -695,15 +695,12 @@ module MailSlurpClient
       if @api_client.config.client_side_validation && email_id.nil?
         fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_html_query"
       end
-      # verify the required parameter 'html_selector' is set
-      if @api_client.config.client_side_validation && html_selector.nil?
-        fail ArgumentError, "Missing the required parameter 'html_selector' when calling EmailControllerApi.get_email_html_query"
-      end
       # resource path
-      local_var_path = '/emails/{emailId}/html-query'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'htmlSelector' + '}', CGI.escape(html_selector.to_s))
+      local_var_path = '/emails/{emailId}/htmlQuery'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'htmlSelector'] = opts[:'html_selector'] if !opts[:'html_selector'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -731,7 +728,7 @@ module MailSlurpClient
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -740,38 +737,38 @@ module MailSlurpClient
 
     # Parse and return text from an email, stripping HTML and decoding encoded characters
     # Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
-    # @param decode_html_entities [Boolean] Decode HTML entities
     # @param email_id [String] ID of email to fetch text for
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode_html_entities Decode HTML entities
+    # @option opts [String] :line_separator Line separator character
     # @return [EmailTextLinesResult]
-    def get_email_text_lines(decode_html_entities, email_id, opts = {})
-      data, _status_code, _headers = get_email_text_lines_with_http_info(decode_html_entities, email_id, opts)
+    def get_email_text_lines(email_id, opts = {})
+      data, _status_code, _headers = get_email_text_lines_with_http_info(email_id, opts)
       data
     end
 
     # Parse and return text from an email, stripping HTML and decoding encoded characters
     # Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
-    # @param decode_html_entities [Boolean] Decode HTML entities
     # @param email_id [String] ID of email to fetch text for
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :decode_html_entities Decode HTML entities
+    # @option opts [String] :line_separator Line separator character
     # @return [Array<(EmailTextLinesResult, Integer, Hash)>] EmailTextLinesResult data, response status code and response headers
-    def get_email_text_lines_with_http_info(decode_html_entities, email_id, opts = {})
+    def get_email_text_lines_with_http_info(email_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_text_lines ...'
       end
-      # verify the required parameter 'decode_html_entities' is set
-      if @api_client.config.client_side_validation && decode_html_entities.nil?
-        fail ArgumentError, "Missing the required parameter 'decode_html_entities' when calling EmailControllerApi.get_email_text_lines"
-      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_text_lines"
       end
       # resource path
-      local_var_path = '/emails/{emailId}/text'.sub('{' + 'decodeHtmlEntities' + '}', CGI.escape(decode_html_entities.to_s)).sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+      local_var_path = '/emails/{emailId}/textLines'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'decodeHtmlEntities'] = opts[:'decode_html_entities'] if !opts[:'decode_html_entities'].nil?
+      query_params[:'lineSeparator'] = opts[:'line_separator'] if !opts[:'line_separator'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -799,7 +796,7 @@ module MailSlurpClient
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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_text_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -881,6 +878,124 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get latest email
+    # Get the newest email in all inboxes or in a passed set of inbox IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
+    # @return [Email]
+    def get_latest_email(opts = {})
+      data, _status_code, _headers = get_latest_email_with_http_info(opts)
+      data
+    end
+
+    # Get latest email
+    # Get the newest email in all inboxes or in a passed set of inbox IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs
+    # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
+    def get_latest_email_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_latest_email ...'
+      end
+      # resource path
+      local_var_path = '/emails/latest'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxIds'] = @api_client.build_collection_param(opts[:'inbox_ids'], :multi) if !opts[:'inbox_ids'].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_latest_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get latest email
+    # Get the newest email in all inboxes or in a passed set of inbox IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
+    # @return [Email]
+    def get_latest_email_in_inbox(opts = {})
+      data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(opts)
+      data
+    end
+
+    # Get latest email
+    # Get the newest email in all inboxes or in a passed set of inbox IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id ID of the inbox you want to get the latest email from
+    # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
+    def get_latest_email_in_inbox_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_latest_email_in_inbox ...'
+      end
+      # resource path
+      local_var_path = '/emails/latestIn'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].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_latest_email_in_inbox\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] ID of email

data/lib/mailslurp_client/api/expired_controller_api.rb

@@ -0,0 +1,271 @@
+=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 ExpiredControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get default expiration settings
+    # Return default times used for inbox expiration
+    # @param [Hash] opts the optional parameters
+    # @return [ExpirationDefaults]
+    def get_expiration_defaults(opts = {})
+      data, _status_code, _headers = get_expiration_defaults_with_http_info(opts)
+      data
+    end
+
+    # Get default expiration settings
+    # Return default times used for inbox expiration
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExpirationDefaults, Integer, Hash)>] ExpirationDefaults data, response status code and response headers
+    def get_expiration_defaults_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExpiredControllerApi.get_expiration_defaults ...'
+      end
+      # resource path
+      local_var_path = '/expired/defaults'
+
+      # 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] || 'ExpirationDefaults' 
+
+      # 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: ExpiredControllerApi#get_expiration_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get expired inbox record for a previously existing inbox
+    # Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
+    # @param inbox_id [String] ID of inbox you want to retrieve (not the inbox ID)
+    # @param [Hash] opts the optional parameters
+    # @return [ExpiredInboxDto]
+    def get_expired_inbox_by_inbox_id(inbox_id, opts = {})
+      data, _status_code, _headers = get_expired_inbox_by_inbox_id_with_http_info(inbox_id, opts)
+      data
+    end
+
+    # Get expired inbox record for a previously existing inbox
+    # Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId
+    # @param inbox_id [String] ID of inbox you want to retrieve (not the inbox ID)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExpiredInboxDto, Integer, Hash)>] ExpiredInboxDto data, response status code and response headers
+    def get_expired_inbox_by_inbox_id_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExpiredControllerApi.get_expired_inbox_by_inbox_id ...'
+      end
+      # verify the required parameter 'inbox_id' is set
+      if @api_client.config.client_side_validation && inbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling ExpiredControllerApi.get_expired_inbox_by_inbox_id"
+      end
+      # resource path
+      local_var_path = '/expired/inbox/{inboxId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_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] || 'ExpiredInboxDto' 
+
+      # 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: ExpiredControllerApi#get_expired_inbox_by_inbox_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an expired inbox record
+    # Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
+    # @param expired_id [String] ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
+    # @param [Hash] opts the optional parameters
+    # @return [ExpiredInboxDto]
+    def get_expired_inbox_record(expired_id, opts = {})
+      data, _status_code, _headers = get_expired_inbox_record_with_http_info(expired_id, opts)
+      data
+    end
+
+    # Get an expired inbox record
+    # Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
+    # @param expired_id [String] ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExpiredInboxDto, Integer, Hash)>] ExpiredInboxDto data, response status code and response headers
+    def get_expired_inbox_record_with_http_info(expired_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExpiredControllerApi.get_expired_inbox_record ...'
+      end
+      # verify the required parameter 'expired_id' is set
+      if @api_client.config.client_side_validation && expired_id.nil?
+        fail ArgumentError, "Missing the required parameter 'expired_id' when calling ExpiredControllerApi.get_expired_inbox_record"
+      end
+      # resource path
+      local_var_path = '/expired/{expiredId}'.sub('{' + 'expiredId' + '}', CGI.escape(expired_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] || 'ExpiredInboxDto' 
+
+      # 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: ExpiredControllerApi#get_expired_inbox_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List records of expired inboxes
+    # Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageExpiredInboxRecordProjection]
+    def get_expired_inboxes(opts = {})
+      data, _status_code, _headers = get_expired_inboxes_with_http_info(opts)
+      data
+    end
+
+    # List records of expired inboxes
+    # Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in inbox sent email list pagination
+    # @option opts [Integer] :size Optional page size in inbox sent email list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageExpiredInboxRecordProjection, Integer, Hash)>] PageExpiredInboxRecordProjection data, response status code and response headers
+    def get_expired_inboxes_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExpiredControllerApi.get_expired_inboxes ...'
+      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 = '/expired'
+
+      # 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] || 'PageExpiredInboxRecordProjection' 
+
+      # 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: ExpiredControllerApi#get_expired_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end