mailslurp_client 8.7.1 → 11.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1622ed62e75602880ac96b6d80b157964640c39ffd88e3ea7c4f520a2533a96f
-  data.tar.gz: 8fe1dbc6fd7a3892bd8fe12aeaa9cb8a4299f29077da03865ed8d7938d8f0ed5
+  metadata.gz: f4ab99cf6e32e9b983aba0a4af539dc48d6ec35dfed539ef5c4c32c859bc8d09
+  data.tar.gz: 22c979df15e3c0c7fae1ec784b872104d8f72cc7e83094640ecd49adcf5c03ba
 SHA512:
-  metadata.gz: 6e33934b0a5cb9be6d384a210fb0ee6b4c8317e654f694415db24eb2e3eb6fead5db5e810676921f241bac9609fefca47bd9c3d938dc354288621c831dfaa993
-  data.tar.gz: c0f0cec1c962bfcdbc6d8f9f825079f0eaf4e937903548fa890854ffe9ebfa33e5bce4cd2eda439cb33f3dd22b4bf5c4c8f0347a8fae0ad4c998d33af03d433c
+  metadata.gz: 512ea12d39289c7404a0ef94b0a34d81969c05efd2c7a1c986be0c1aeb86960dffe6f7d3edaf6db6c796fb36bd12dd70900df1b78307b77d099a58b702b8f95d
+  data.tar.gz: 8103ac2eaae0f5281d7f625578676ce8505c3c392266ba6ca6dcb19375c4cba192200a1a0489e91fa703c65bb81c430dbecc51d373c7cc407993da75dcaf5980

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
+Copyright 2021 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/lib/mailslurp_client.rb

@@ -38,6 +38,7 @@ require 'mailslurp_client/models/dns_lookup_results'
 require 'mailslurp_client/models/describe_domain_options'
 require 'mailslurp_client/models/describe_mail_server_domain_result'
 require 'mailslurp_client/models/domain_dto'
+require 'mailslurp_client/models/domain_name_record'
 require 'mailslurp_client/models/domain_preview'
 require 'mailslurp_client/models/download_attachment_dto'
 require 'mailslurp_client/models/email'
@@ -45,7 +46,10 @@ require 'mailslurp_client/models/email_analysis'
 require 'mailslurp_client/models/email_content_match_result'
 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/expired_inbox_dto'
+require 'mailslurp_client/models/expired_inbox_record_projection'
 require 'mailslurp_client/models/forward_email_options'
 require 'mailslurp_client/models/group_contacts_dto'
 require 'mailslurp_client/models/group_dto'
@@ -62,6 +66,7 @@ require 'mailslurp_client/models/page_alias'
 require 'mailslurp_client/models/page_contact_projection'
 require 'mailslurp_client/models/page_email_preview'
 require 'mailslurp_client/models/page_email_projection'
+require 'mailslurp_client/models/page_expired_inbox_record_projection'
 require 'mailslurp_client/models/page_group_projection'
 require 'mailslurp_client/models/page_inbox_projection'
 require 'mailslurp_client/models/page_sent_email_projection'

data/lib/mailslurp_client/api/alias_controller_api.rb

@@ -499,7 +499,7 @@ module MailSlurpClient
     end
 
     # Send an email from an alias inbox
-    # Send an email from an alias. Replies to the email will be forwared to the alias masked email address
+    # Send an email from an alias. Replies to the email will be forwarded to the alias masked email address
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email to be sent
@@ -510,7 +510,7 @@ module MailSlurpClient
     end
 
     # Send an email from an alias inbox
-    # Send an email from an alias. Replies to the email will be forwared to the alias masked email address
+    # Send an email from an alias. Replies to the email will be forwarded to the alias masked email address
     # @param alias_id [String] aliasId
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email to be sent

data/lib/mailslurp_client/api/common_actions_controller_api.rb

@@ -22,6 +22,9 @@ module MailSlurpClient
     # Create new random inbox
     # Returns an Inbox with an `id` and an `emailAddress`
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :expires_at expiresAt
+    # @option opts [Integer] :expires_in expiresIn
+    # @option opts [Boolean] :use_domain_pool useDomainPool
     # @return [Inbox]
     def create_new_email_address(opts = {})
       data, _status_code, _headers = create_new_email_address_with_http_info(opts)
@@ -31,6 +34,9 @@ module MailSlurpClient
     # Create new random inbox
     # Returns an Inbox with an `id` and an `emailAddress`
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :expires_at expiresAt
+    # @option opts [Integer] :expires_in expiresIn
+    # @option opts [Boolean] :use_domain_pool useDomainPool
     # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
     def create_new_email_address_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -41,6 +47,9 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'expiresAt'] = opts[:'expires_at'] if !opts[:'expires_at'].nil?
+      query_params[:'expiresIn'] = opts[:'expires_in'] if !opts[:'expires_in'].nil?
+      query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -78,6 +87,9 @@ module MailSlurpClient
     # Create new random inbox
     # Returns an Inbox with an `id` and an `emailAddress`
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :expires_at expiresAt
+    # @option opts [Integer] :expires_in expiresIn
+    # @option opts [Boolean] :use_domain_pool useDomainPool
     # @return [Inbox]
     def create_new_email_address1(opts = {})
       data, _status_code, _headers = create_new_email_address1_with_http_info(opts)
@@ -87,6 +99,9 @@ module MailSlurpClient
     # Create new random inbox
     # Returns an Inbox with an &#x60;id&#x60; and an &#x60;emailAddress&#x60;
     # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :expires_at expiresAt
+    # @option opts [Integer] :expires_in expiresIn
+    # @option opts [Boolean] :use_domain_pool useDomainPool
     # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
     def create_new_email_address1_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -97,6 +112,9 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'expiresAt'] = opts[:'expires_at'] if !opts[:'expires_at'].nil?
+      query_params[:'expiresIn'] = opts[:'expires_in'] if !opts[:'expires_in'].nil?
+      query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -670,6 +670,136 @@ module MailSlurpClient
       return data, status_code, headers
     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 [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, 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 [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, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html_query ...'
+      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_query"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/html-query'.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] || {}
+      # 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] || 'EmailTextLinesResult' 
+
+      # 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#get_email_html_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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 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
+    # @return [EmailTextLinesResult]
+    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 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
+    # @return [Array<(EmailTextLinesResult, Integer, Hash)>] EmailTextLinesResult data, response status code and response headers
+    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 '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('{' + '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?
+
+      # 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] || 'EmailTextLinesResult' 
+
+      # 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#get_email_text_lines\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

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -22,12 +22,14 @@ module MailSlurpClient
     # Create an Inbox (email address)
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :description Optional description for an inbox.
-    # @option opts [String] :email_address Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or `createDomain` method.
-    # @option opts [DateTime] :expires_at Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates
-    # @option opts [Boolean] :favourite Is inbox favourited.
-    # @option opts [String] :name Optional name for an inbox.
-    # @option opts [Array<String>] :tags Optional tags for an inbox. Can be used for searching and filtering inboxes.
+    # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
+    # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as &#x60;123@mailslurp.com&#x60;. If you use the &#x60;useDomainPool&#x60; option when the email address is null it will generate an email address with a more varied domain ending such as &#x60;123@mailslurp.info&#x60; or &#x60;123@mailslurp.biz&#x60;. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
+    # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won&#39;t be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSSXXX.
+    # @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
+    # @option opts [Boolean] :favourite Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
+    # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search
+    # @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
+    # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field.
     # @return [Inbox]
     def create_inbox(opts = {})
       data, _status_code, _headers = create_inbox_with_http_info(opts)
@@ -37,12 +39,14 @@ module MailSlurpClient
     # Create an Inbox (email address)
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :description Optional description for an inbox.
-    # @option opts [String] :email_address Optional email address including domain you wish inbox to use (eg: test123@mydomain.com). Only supports domains that you have registered and verified with MailSlurp using dashboard or &#x60;createDomain&#x60; method.
-    # @option opts [DateTime] :expires_at Optional expires at timestamp. If your plan supports this feature you can specify when an inbox should expire. If left empty inbox will exist permanently or expire when your plan dictates
-    # @option opts [Boolean] :favourite Is inbox favourited.
-    # @option opts [String] :name Optional name for an inbox.
-    # @option opts [Array<String>] :tags Optional tags for an inbox. Can be used for searching and filtering inboxes.
+    # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
+    # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as &#x60;123@mailslurp.com&#x60;. If you use the &#x60;useDomainPool&#x60; option when the email address is null it will generate an email address with a more varied domain ending such as &#x60;123@mailslurp.info&#x60; or &#x60;123@mailslurp.biz&#x60;. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
+    # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won&#39;t be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSSXXX.
+    # @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
+    # @option opts [Boolean] :favourite Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
+    # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search
+    # @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
+    # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field.
     # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
     def create_inbox_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -56,9 +60,11 @@ module MailSlurpClient
       query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
       query_params[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil?
       query_params[:'expiresAt'] = opts[:'expires_at'] if !opts[:'expires_at'].nil?
+      query_params[:'expiresIn'] = opts[:'expires_in'] if !opts[:'expires_in'].nil?
       query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
       query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
       query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
+      query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -212,7 +218,7 @@ module MailSlurpClient
     end
 
     # Delete inbox
-    # Permanently delete an inbox and associated email address aswell as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
+    # Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -222,7 +228,7 @@ module MailSlurpClient
     end
 
     # Delete inbox
-    # Permanently delete an inbox and associated email address aswell as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
+    # Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -433,6 +439,199 @@ module MailSlurpClient
       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_by_id(expired_id, opts = {})
+      data, _status_code, _headers = get_expired_inbox_record_by_id_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_by_id_with_http_info(expired_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_expired_inbox_record_by_id ...'
+      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 InboxControllerApi.get_expired_inbox_record_by_id"
+      end
+      # resource path
+      local_var_path = '/inboxes/expired-records/{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: InboxControllerApi#get_expired_inbox_record_by_id\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_record_by_inbox_id(inbox_id, opts = {})
+      data, _status_code, _headers = get_expired_inbox_record_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_record_by_inbox_id_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_expired_inbox_record_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 InboxControllerApi.get_expired_inbox_record_by_inbox_id"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/expired-record'.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: InboxControllerApi#get_expired_inbox_record_by_inbox_id\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_inbox_records(opts = {})
+      data, _status_code, _headers = get_expired_inbox_records_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_inbox_records_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_expired_inbox_records ...'
+      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 = '/inboxes/expired-records'
+
+      # 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: InboxControllerApi#get_expired_inbox_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Inbox
     # Returns an inbox's properties, including its email address and ID.
     # @param inbox_id [String] inboxId