mailslurp_client 16.1.5 → 16.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 856fe42228f69fb4c2f0d63942ebc8abbfdceb45993a801761dfc88bb9218b3e
-  data.tar.gz: 0bbdb8d6f4c7761c9e072402f38c11d3fb8573a95301f80883de226f7a9f3bfa
+  metadata.gz: b5b4b6bf42a8a4d23d80cad63a8d4eb6cb7d104ca8d61f6e1d1101b130c9784e
+  data.tar.gz: be202e94ab59f21ef765716134722258ad6f52facd843341a41a91ae6dacd09c
 SHA512:
-  metadata.gz: 34cac678e2664a9f8a9ee70538a5425e99467e0d51d758bcdca8fb618b8603838ab4e085673dc87847d30693c36dcd38bfee4e28568de883694e2d7799c140e7
-  data.tar.gz: 36a034b7bbba942f0ecb57028d83bc7389c9e18d72e167b4fab1cb0c2d4c533221abae5a15ba5a08decd92e6165cc03426b0899b0c7b876f41eb38ef71c14a88
+  metadata.gz: cf2b0aea992f3e0e58192ba13f6377998e303763dd537a02054039ce83825528ca9aa8d7eab37ef6646bb94871d4e00aa09680b6ff4f95f1c28f704f3e16dabe
+  data.tar.gz: 5115306bc8b51bf8c7f841add0bd5ecc9a03f50cdbc2cc0198fcf967b3fcb3fcfd6f7cdd26cc73dff6f5e2243fda036595d2462e39b65a4ddaf03c32b57d6063

data/lib/mailslurp_client/api/mfa_controller_api.rb

@@ -0,0 +1,342 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
+
+The version of the OpenAPI document: 6.5.2
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module MailSlurpClient
+  class MFAControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a TOTP device from custom options
+    # Create a virtual TOTP device for custom options specifying all parameters of the TOTP device.
+    # @param create_totp_device_otp_auth_url_options [CreateTotpDeviceOtpAuthUrlOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [TotpDeviceDto]
+    def create_totp_device_for_custom(create_totp_device_otp_auth_url_options, opts = {})
+      data, _status_code, _headers = create_totp_device_for_custom_with_http_info(create_totp_device_otp_auth_url_options, opts)
+      data
+    end
+
+    # Create a TOTP device from custom options
+    # Create a virtual TOTP device for custom options specifying all parameters of the TOTP device.
+    # @param create_totp_device_otp_auth_url_options [CreateTotpDeviceOtpAuthUrlOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TotpDeviceDto, Integer, Hash)>] TotpDeviceDto data, response status code and response headers
+    def create_totp_device_for_custom_with_http_info(create_totp_device_otp_auth_url_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MFAControllerApi.create_totp_device_for_custom ...'
+      end
+      # verify the required parameter 'create_totp_device_otp_auth_url_options' is set
+      if @api_client.config.client_side_validation && create_totp_device_otp_auth_url_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_totp_device_otp_auth_url_options' when calling MFAControllerApi.create_totp_device_for_custom"
+      end
+      # resource path
+      local_var_path = '/mfa/totp/device/custom'
+
+      # 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(['*/*'])
+      # 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(create_totp_device_otp_auth_url_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'TotpDeviceDto' 
+
+      # 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: MFAControllerApi#create_totp_device_for_custom\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a TOTP device from an OTP Auth URL
+    # Create a virtual TOTP device for a given OTP Auth URL such as otpauth://totp/MyApp:alice@example.com?secret=ABC123&issuer=MyApp&period=30&digits=6&algorithm=SHA1. You can provider overrides in the options for each component of the URL.
+    # @param create_totp_device_otp_auth_url_options [CreateTotpDeviceOtpAuthUrlOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [TotpDeviceDto]
+    def create_totp_device_for_otp_auth_url(create_totp_device_otp_auth_url_options, opts = {})
+      data, _status_code, _headers = create_totp_device_for_otp_auth_url_with_http_info(create_totp_device_otp_auth_url_options, opts)
+      data
+    end
+
+    # Create a TOTP device from an OTP Auth URL
+    # Create a virtual TOTP device for a given OTP Auth URL such as otpauth://totp/MyApp:alice@example.com?secret&#x3D;ABC123&amp;issuer&#x3D;MyApp&amp;period&#x3D;30&amp;digits&#x3D;6&amp;algorithm&#x3D;SHA1. You can provider overrides in the options for each component of the URL.
+    # @param create_totp_device_otp_auth_url_options [CreateTotpDeviceOtpAuthUrlOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TotpDeviceDto, Integer, Hash)>] TotpDeviceDto data, response status code and response headers
+    def create_totp_device_for_otp_auth_url_with_http_info(create_totp_device_otp_auth_url_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MFAControllerApi.create_totp_device_for_otp_auth_url ...'
+      end
+      # verify the required parameter 'create_totp_device_otp_auth_url_options' is set
+      if @api_client.config.client_side_validation && create_totp_device_otp_auth_url_options.nil?
+        fail ArgumentError, "Missing the required parameter 'create_totp_device_otp_auth_url_options' when calling MFAControllerApi.create_totp_device_for_otp_auth_url"
+      end
+      # resource path
+      local_var_path = '/mfa/totp/device/otpAuthUrl'
+
+      # 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(['*/*'])
+      # 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(create_totp_device_otp_auth_url_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'TotpDeviceDto' 
+
+      # 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: MFAControllerApi#create_totp_device_for_otp_auth_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a TOTP device by ID
+    # Get Time-Based One-Time Password (TOTP) device by its ID.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [TotpDeviceDto]
+    def get_totp_device(id, opts = {})
+      data, _status_code, _headers = get_totp_device_with_http_info(id, opts)
+      data
+    end
+
+    # Get a TOTP device by ID
+    # Get Time-Based One-Time Password (TOTP) device by its ID.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TotpDeviceDto, Integer, Hash)>] TotpDeviceDto data, response status code and response headers
+    def get_totp_device_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MFAControllerApi.get_totp_device ...'
+      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 MFAControllerApi.get_totp_device"
+      end
+      # resource path
+      local_var_path = '/mfa/totp/device/{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(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'TotpDeviceDto' 
+
+      # 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: MFAControllerApi#get_totp_device\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a TOTP device by username, issuer, or name. Returns empty if not found.
+    # Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name Optional name filter
+    # @option opts [String] :issuer Optional issuer filter
+    # @option opts [String] :username Optional username filter
+    # @return [TotpDeviceOptionalDto]
+    def get_totp_device_by(opts = {})
+      data, _status_code, _headers = get_totp_device_by_with_http_info(opts)
+      data
+    end
+
+    # Get a TOTP device by username, issuer, or name. Returns empty if not found.
+    # Get Time-Based One-Time Password (TOTP) device by its username and issuer mapping.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name Optional name filter
+    # @option opts [String] :issuer Optional issuer filter
+    # @option opts [String] :username Optional username filter
+    # @return [Array<(TotpDeviceOptionalDto, Integer, Hash)>] TotpDeviceOptionalDto data, response status code and response headers
+    def get_totp_device_by_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MFAControllerApi.get_totp_device_by ...'
+      end
+      # resource path
+      local_var_path = '/mfa/totp/device/by'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'issuer'] = opts[:'issuer'] if !opts[:'issuer'].nil?
+      query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'TotpDeviceOptionalDto' 
+
+      # 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: MFAControllerApi#get_totp_device_by\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a TOTP device code by device ID
+    # Get Time-Based One-Time Password for a device by its ID.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :at 
+    # @return [TotpDeviceCodeDto]
+    def get_totp_device_code(id, opts = {})
+      data, _status_code, _headers = get_totp_device_code_with_http_info(id, opts)
+      data
+    end
+
+    # Get a TOTP device code by device ID
+    # Get Time-Based One-Time Password for a device by its ID.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [DateTime] :at 
+    # @return [Array<(TotpDeviceCodeDto, Integer, Hash)>] TotpDeviceCodeDto data, response status code and response headers
+    def get_totp_device_code_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MFAControllerApi.get_totp_device_code ...'
+      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 MFAControllerApi.get_totp_device_code"
+      end
+      # resource path
+      local_var_path = '/mfa/totp/device/{id}/code'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'at'] = opts[:'at'] if !opts[:'at'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'TotpDeviceCodeDto' 
+
+      # 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: MFAControllerApi#get_totp_device_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/mailslurp_client/models/alias_thread_projection.rb

@@ -15,6 +15,9 @@ require 'date'
 module MailSlurpClient
   # A thread is a message thread created for a message received by an alias
   class AliasThreadProjection
+    # Thread subject
+    attr_accessor :subject
+
     # Inbox ID
     attr_accessor :inbox_id
 
@@ -39,9 +42,6 @@ module MailSlurpClient
     # Alias ID
     attr_accessor :alias_id
 
-    # Thread subject
-    attr_accessor :subject
-
     # Name of thread
     attr_accessor :name
 
@@ -51,6 +51,7 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'subject' => :'subject',
         :'inbox_id' => :'inboxId',
         :'user_id' => :'userId',
         :'updated_at' => :'updatedAt',
@@ -59,7 +60,6 @@ module MailSlurpClient
         :'cc' => :'cc',
         :'bcc' => :'bcc',
         :'alias_id' => :'aliasId',
-        :'subject' => :'subject',
         :'name' => :'name',
         :'id' => :'id'
       }
@@ -68,6 +68,7 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'subject' => :'String',
         :'inbox_id' => :'String',
         :'user_id' => :'String',
         :'updated_at' => :'DateTime',
@@ -76,7 +77,6 @@ module MailSlurpClient
         :'cc' => :'Array<String>',
         :'bcc' => :'Array<String>',
         :'alias_id' => :'String',
-        :'subject' => :'String',
         :'name' => :'String',
         :'id' => :'String'
       }
@@ -103,6 +103,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
       if attributes.key?(:'inbox_id')
         self.inbox_id = attributes[:'inbox_id']
       end
@@ -141,10 +145,6 @@ module MailSlurpClient
         self.alias_id = attributes[:'alias_id']
       end
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -207,6 +207,7 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          subject == o.subject &&
           inbox_id == o.inbox_id &&
           user_id == o.user_id &&
           updated_at == o.updated_at &&
@@ -215,7 +216,6 @@ module MailSlurpClient
           cc == o.cc &&
           bcc == o.bcc &&
           alias_id == o.alias_id &&
-          subject == o.subject &&
           name == o.name &&
           id == o.id
     end
@@ -229,7 +229,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [inbox_id, user_id, updated_at, created_at, to, cc, bcc, alias_id, subject, name, id].hash
+      [subject, inbox_id, user_id, updated_at, created_at, to, cc, bcc, alias_id, name, id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/bounce_projection.rb

@@ -15,6 +15,8 @@ require 'date'
 module MailSlurpClient
   # Bounced email event
   class BounceProjection
+    attr_accessor :subject
+
     attr_accessor :sender
 
     attr_accessor :created_at
@@ -23,18 +25,16 @@ module MailSlurpClient
 
     attr_accessor :bounce_mta
 
-    attr_accessor :subject
-
     attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'subject' => :'subject',
         :'sender' => :'sender',
         :'created_at' => :'createdAt',
         :'bounce_type' => :'bounceType',
         :'bounce_mta' => :'bounceMta',
-        :'subject' => :'subject',
         :'id' => :'id'
       }
     end
@@ -42,11 +42,11 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'subject' => :'String',
         :'sender' => :'String',
         :'created_at' => :'DateTime',
         :'bounce_type' => :'String',
         :'bounce_mta' => :'String',
-        :'subject' => :'String',
         :'id' => :'String'
       }
     end
@@ -54,9 +54,9 @@ module MailSlurpClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'subject',
         :'bounce_type',
         :'bounce_mta',
-        :'subject',
       ])
     end
 
@@ -75,6 +75,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
       if attributes.key?(:'sender')
         self.sender = attributes[:'sender']
       end
@@ -91,10 +95,6 @@ module MailSlurpClient
         self.bounce_mta = attributes[:'bounce_mta']
       end
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -128,11 +128,11 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          subject == o.subject &&
           sender == o.sender &&
           created_at == o.created_at &&
           bounce_type == o.bounce_type &&
           bounce_mta == o.bounce_mta &&
-          subject == o.subject &&
           id == o.id
     end
 
@@ -145,7 +145,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sender, created_at, bounce_type, bounce_mta, subject, id].hash
+      [subject, sender, created_at, bounce_type, bounce_mta, id].hash
     end
 
     # Builds the object from hash