mailslurp_client 15.0.1 → 15.0.5

data/lib/mailslurp_client/api/common_actions_controller_api.rb

@@ -22,17 +22,17 @@ module MailSlurpClient
     # Create new random inbox
     # Returns an Inbox with an `id` and an `emailAddress`
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :allow_team_access allowTeamAccess
-    # @option opts [String] :description description
-    # @option opts [String] :email_address emailAddress
-    # @option opts [DateTime] :expires_at expiresAt
-    # @option opts [Integer] :expires_in expiresIn
-    # @option opts [Boolean] :favourite favourite
-    # @option opts [String] :inbox_type inboxType
-    # @option opts [String] :name name
-    # @option opts [Array<String>] :tags tags
-    # @option opts [Boolean] :use_domain_pool useDomainPool
-    # @return [Inbox]
+    # @option opts [Boolean] :allow_team_access 
+    # @option opts [Boolean] :use_domain_pool 
+    # @option opts [DateTime] :expires_at 
+    # @option opts [Integer] :expires_in 
+    # @option opts [String] :email_address 
+    # @option opts [String] :inbox_type 
+    # @option opts [String] :description 
+    # @option opts [String] :name 
+    # @option opts [Array<String>] :tags 
+    # @option opts [Boolean] :favourite 
+    # @return [InboxDto]
     def create_new_email_address(opts = {})
       data, _status_code, _headers = create_new_email_address_with_http_info(opts)
       data
@@ -41,17 +41,17 @@ 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 [Boolean] :allow_team_access allowTeamAccess
-    # @option opts [String] :description description
-    # @option opts [String] :email_address emailAddress
-    # @option opts [DateTime] :expires_at expiresAt
-    # @option opts [Integer] :expires_in expiresIn
-    # @option opts [Boolean] :favourite favourite
-    # @option opts [String] :inbox_type inboxType
-    # @option opts [String] :name name
-    # @option opts [Array<String>] :tags tags
-    # @option opts [Boolean] :use_domain_pool useDomainPool
-    # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
+    # @option opts [Boolean] :allow_team_access 
+    # @option opts [Boolean] :use_domain_pool 
+    # @option opts [DateTime] :expires_at 
+    # @option opts [Integer] :expires_in 
+    # @option opts [String] :email_address 
+    # @option opts [String] :inbox_type 
+    # @option opts [String] :description 
+    # @option opts [String] :name 
+    # @option opts [Array<String>] :tags 
+    # @option opts [Boolean] :favourite 
+    # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
     def create_new_email_address_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CommonActionsControllerApi.create_new_email_address ...'
@@ -66,20 +66,20 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'allowTeamAccess'] = opts[:'allow_team_access'] if !opts[:'allow_team_access'].nil?
-      query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
-      query_params[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil?
+      query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].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[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil?
       query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
+      query_params[:'description'] = opts[:'description'] if !opts[:'description'].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?
+      query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -88,7 +88,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'Inbox' 
+      return_type = opts[:return_type] || 'InboxDto' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -112,17 +112,17 @@ module MailSlurpClient
     # Create new random inbox
     # Returns an Inbox with an `id` and an `emailAddress`
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :allow_team_access allowTeamAccess
-    # @option opts [String] :description description
-    # @option opts [String] :email_address emailAddress
-    # @option opts [DateTime] :expires_at expiresAt
-    # @option opts [Integer] :expires_in expiresIn
-    # @option opts [Boolean] :favourite favourite
-    # @option opts [String] :inbox_type inboxType
-    # @option opts [String] :name name
-    # @option opts [Array<String>] :tags tags
-    # @option opts [Boolean] :use_domain_pool useDomainPool
-    # @return [Inbox]
+    # @option opts [Boolean] :allow_team_access 
+    # @option opts [Boolean] :use_domain_pool 
+    # @option opts [DateTime] :expires_at 
+    # @option opts [Integer] :expires_in 
+    # @option opts [String] :email_address 
+    # @option opts [String] :inbox_type 
+    # @option opts [String] :description 
+    # @option opts [String] :name 
+    # @option opts [Array<String>] :tags 
+    # @option opts [Boolean] :favourite 
+    # @return [InboxDto]
     def create_new_email_address1(opts = {})
       data, _status_code, _headers = create_new_email_address1_with_http_info(opts)
       data
@@ -131,17 +131,17 @@ 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 [Boolean] :allow_team_access allowTeamAccess
-    # @option opts [String] :description description
-    # @option opts [String] :email_address emailAddress
-    # @option opts [DateTime] :expires_at expiresAt
-    # @option opts [Integer] :expires_in expiresIn
-    # @option opts [Boolean] :favourite favourite
-    # @option opts [String] :inbox_type inboxType
-    # @option opts [String] :name name
-    # @option opts [Array<String>] :tags tags
-    # @option opts [Boolean] :use_domain_pool useDomainPool
-    # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
+    # @option opts [Boolean] :allow_team_access 
+    # @option opts [Boolean] :use_domain_pool 
+    # @option opts [DateTime] :expires_at 
+    # @option opts [Integer] :expires_in 
+    # @option opts [String] :email_address 
+    # @option opts [String] :inbox_type 
+    # @option opts [String] :description 
+    # @option opts [String] :name 
+    # @option opts [Array<String>] :tags 
+    # @option opts [Boolean] :favourite 
+    # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
     def create_new_email_address1_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CommonActionsControllerApi.create_new_email_address1 ...'
@@ -156,20 +156,20 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'allowTeamAccess'] = opts[:'allow_team_access'] if !opts[:'allow_team_access'].nil?
-      query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
-      query_params[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil?
+      query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].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[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil?
       query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
+      query_params[:'description'] = opts[:'description'] if !opts[:'description'].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?
+      query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -178,7 +178,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'Inbox' 
+      return_type = opts[:return_type] || 'InboxDto' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -199,9 +199,70 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Delete inbox email address by inbox id
+    # Deletes inbox email address
+    # @param inbox_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_email_address(inbox_id, opts = {})
+      delete_email_address_with_http_info(inbox_id, opts)
+      nil
+    end
+
+    # Delete inbox email address by inbox id
+    # Deletes inbox email address
+    # @param inbox_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_email_address_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonActionsControllerApi.delete_email_address ...'
+      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 CommonActionsControllerApi.delete_email_address"
+      end
+      # resource path
+      local_var_path = '/deleteEmailAddress'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = inbox_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommonActionsControllerApi#delete_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete all emails in an inbox
     # Deletes all emails
-    # @param inbox_id [String] inboxId
+    # @param inbox_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def empty_inbox(inbox_id, opts = {})
@@ -211,7 +272,7 @@ module MailSlurpClient
 
     # Delete all emails in an inbox
     # Deletes all emails
-    # @param inbox_id [String] inboxId
+    # @param inbox_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def empty_inbox_with_http_info(inbox_id, opts = {})
@@ -262,26 +323,26 @@ module MailSlurpClient
 
     # Send an email
     # If no senderId or inboxId provided a random email address will be used to send from.
-    # @param email_options [SimpleSendEmailOptions] emailOptions
+    # @param simple_send_email_options [SimpleSendEmailOptions] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def send_email_simple(email_options, opts = {})
-      send_email_simple_with_http_info(email_options, opts)
+    def send_email_simple(simple_send_email_options, opts = {})
+      send_email_simple_with_http_info(simple_send_email_options, opts)
       nil
     end
 
     # Send an email
     # If no senderId or inboxId provided a random email address will be used to send from.
-    # @param email_options [SimpleSendEmailOptions] emailOptions
+    # @param simple_send_email_options [SimpleSendEmailOptions] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def send_email_simple_with_http_info(email_options, opts = {})
+    def send_email_simple_with_http_info(simple_send_email_options, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CommonActionsControllerApi.send_email_simple ...'
       end
-      # verify the required parameter 'email_options' is set
-      if @api_client.config.client_side_validation && email_options.nil?
-        fail ArgumentError, "Missing the required parameter 'email_options' when calling CommonActionsControllerApi.send_email_simple"
+      # verify the required parameter 'simple_send_email_options' is set
+      if @api_client.config.client_side_validation && simple_send_email_options.nil?
+        fail ArgumentError, "Missing the required parameter 'simple_send_email_options' when calling CommonActionsControllerApi.send_email_simple"
       end
       # resource path
       local_var_path = '/sendEmail'
@@ -298,7 +359,7 @@ module MailSlurpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(email_options) 
+      post_body = opts[:body] || @api_client.object_to_http_body(simple_send_email_options) 
 
       # return_type
       return_type = opts[:return_type] 

data/lib/mailslurp_client/api/contact_controller_api.rb

@@ -20,7 +20,7 @@ module MailSlurpClient
       @api_client = api_client
     end
     # Create a contact
-    # @param create_contact_options [CreateContactOptions] createContactOptions
+    # @param create_contact_options [CreateContactOptions] 
     # @param [Hash] opts the optional parameters
     # @return [ContactDto]
     def create_contact(create_contact_options, opts = {})
@@ -29,7 +29,7 @@ module MailSlurpClient
     end
 
     # Create a contact
-    # @param create_contact_options [CreateContactOptions] createContactOptions
+    # @param create_contact_options [CreateContactOptions] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ContactDto, Integer, Hash)>] ContactDto data, response status code and response headers
     def create_contact_with_http_info(create_contact_options, opts = {})
@@ -49,7 +49,7 @@ module MailSlurpClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
@@ -82,7 +82,7 @@ module MailSlurpClient
     end
 
     # Delete contact
-    # @param contact_id [String] contactId
+    # @param contact_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def delete_contact(contact_id, opts = {})
@@ -91,7 +91,7 @@ module MailSlurpClient
     end
 
     # Delete contact
-    # @param contact_id [String] contactId
+    # @param contact_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_contact_with_http_info(contact_id, opts = {})
@@ -141,11 +141,11 @@ module MailSlurpClient
 
     # Get all contacts
     # @param [Hash] opts the optional parameters
-    # @option opts [DateTime] :before Filter by created at before the given timestamp
     # @option opts [Integer] :page Optional page index in list pagination (default to 0)
-    # @option opts [DateTime] :since Filter by created at after the given timestamp
     # @option opts [Integer] :size Optional page size in list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
     # @return [PageContactProjection]
     def get_all_contacts(opts = {})
       data, _status_code, _headers = get_all_contacts_with_http_info(opts)
@@ -154,11 +154,11 @@ module MailSlurpClient
 
     # Get all contacts
     # @param [Hash] opts the optional parameters
-    # @option opts [DateTime] :before Filter by created at before the given timestamp
     # @option opts [Integer] :page Optional page index in list pagination
-    # @option opts [DateTime] :since Filter by created at after the given timestamp
     # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @option opts [DateTime] :since Filter by created at after the given timestamp
+    # @option opts [DateTime] :before Filter by created at before the given timestamp
     # @return [Array<(PageContactProjection, Integer, Hash)>] PageContactProjection data, response status code and response headers
     def get_all_contacts_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -173,16 +173,16 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
-      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -213,7 +213,7 @@ module MailSlurpClient
     end
 
     # Get contact
-    # @param contact_id [String] contactId
+    # @param contact_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [ContactDto]
     def get_contact(contact_id, opts = {})
@@ -222,7 +222,7 @@ module MailSlurpClient
     end
 
     # Get contact
-    # @param contact_id [String] contactId
+    # @param contact_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ContactDto, Integer, Hash)>] ContactDto data, response status code and response headers
     def get_contact_with_http_info(contact_id, opts = {})
@@ -242,7 +242,7 @@ module MailSlurpClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -273,18 +273,18 @@ module MailSlurpClient
     end
 
     # Get contact vCard vcf file
-    # @param contact_id [String] contactId
+    # @param contact_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [String]
+    # @return [Array<String>]
     def get_contact_v_card(contact_id, opts = {})
       data, _status_code, _headers = get_contact_v_card_with_http_info(contact_id, opts)
       data
     end
 
     # Get contact vCard vcf file
-    # @param contact_id [String] contactId
+    # @param contact_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     def get_contact_v_card_with_http_info(contact_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContactControllerApi.get_contact_v_card ...'
@@ -302,7 +302,7 @@ module MailSlurpClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -311,7 +311,7 @@ module MailSlurpClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'String' 
+      return_type = opts[:return_type] || 'Array<String>' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']
@@ -356,7 +356,7 @@ module MailSlurpClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
 
       # form parameters
       form_params = opts[:form_params] || {}