mailslurp_client 17.1.0 → 17.3.0

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -935,7 +935,7 @@ module MailSlurpClient
     # @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 [Boolean] :favourite Optionally filter results for favourites only (default to false)
-    # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
+    # @option opts [String] :search Optionally filter by search words partial matching name and email address
     # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
     # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
     # @option opts [DateTime] :since Optional filter by created after given date time
@@ -956,7 +956,7 @@ module MailSlurpClient
     # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @option opts [Boolean] :favourite Optionally filter results for favourites only
-    # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
+    # @option opts [String] :search Optionally filter by search words partial matching name and email address
     # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
     # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
     # @option opts [DateTime] :since Optional filter by created after given date time
@@ -1039,7 +1039,7 @@ module MailSlurpClient
     # @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 [Boolean] :favourite Optionally filter results for favourites only (default to false)
-    # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
+    # @option opts [String] :search Optionally filter by search words partial matching name and email address
     # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
     # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
     # @option opts [DateTime] :since Optional filter by created after given date time
@@ -1060,7 +1060,7 @@ module MailSlurpClient
     # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @option opts [Boolean] :favourite Optionally filter results for favourites only
-    # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
+    # @option opts [String] :search Optionally filter by search words partial matching name and email address
     # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
     # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
     # @option opts [DateTime] :since Optional filter by created after given date time
@@ -3043,6 +3043,146 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get or create a plus address by full address
+    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
+    # @param inbox_id [String] ID of the inbox you want to target
+    # @param full_address [String] Full recipient address including +suffix. Example: `inbox+alias@domain.com`
+    # @param [Hash] opts the optional parameters
+    # @return [PlusAddressDto]
+    def get_or_create_inbox_plus_address(inbox_id, full_address, opts = {})
+      data, _status_code, _headers = get_or_create_inbox_plus_address_with_http_info(inbox_id, full_address, opts)
+      data
+    end
+
+    # Get or create a plus address by full address
+    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
+    # @param inbox_id [String] ID of the inbox you want to target
+    # @param full_address [String] Full recipient address including +suffix. Example: `inbox+alias@domain.com`
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PlusAddressDto, Integer, Hash)>] PlusAddressDto data, response status code and response headers
+    def get_or_create_inbox_plus_address_with_http_info(inbox_id, full_address, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_or_create_inbox_plus_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 InboxControllerApi.get_or_create_inbox_plus_address"
+      end
+      # verify the required parameter 'full_address' is set
+      if @api_client.config.client_side_validation && full_address.nil?
+        fail ArgumentError, "Missing the required parameter 'full_address' when calling InboxControllerApi.get_or_create_inbox_plus_address"
+      end
+      if @api_client.config.client_side_validation && full_address.to_s.length < 1
+        fail ArgumentError, 'invalid value for "full_address" when calling InboxControllerApi.get_or_create_inbox_plus_address, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/plus-addresses/get-or-create'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'fullAddress'] = full_address
+
+      # 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] || 'PlusAddressDto' 
+
+      # 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: InboxControllerApi#get_or_create_inbox_plus_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get or create a plus address by full address without inbox ID
+    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
+    # @param full_address [String] Full recipient address including +suffix. Example: &#x60;inbox+alias@domain.com&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [PlusAddressDto]
+    def get_or_create_plus_address_by_full_address(full_address, opts = {})
+      data, _status_code, _headers = get_or_create_plus_address_by_full_address_with_http_info(full_address, opts)
+      data
+    end
+
+    # Get or create a plus address by full address without inbox ID
+    # Looks up an inbox plus address using a full email address like &#x60;inbox+alias@domain.com&#x60;. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
+    # @param full_address [String] Full recipient address including +suffix. Example: &#x60;inbox+alias@domain.com&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PlusAddressDto, Integer, Hash)>] PlusAddressDto data, response status code and response headers
+    def get_or_create_plus_address_by_full_address_with_http_info(full_address, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_or_create_plus_address_by_full_address ...'
+      end
+      # verify the required parameter 'full_address' is set
+      if @api_client.config.client_side_validation && full_address.nil?
+        fail ArgumentError, "Missing the required parameter 'full_address' when calling InboxControllerApi.get_or_create_plus_address_by_full_address"
+      end
+      if @api_client.config.client_side_validation && full_address.to_s.length < 1
+        fail ArgumentError, 'invalid value for "full_address" when calling InboxControllerApi.get_or_create_plus_address_by_full_address, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/inboxes/get-or-create-plus-address'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'fullAddress'] = full_address
+
+      # 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] || 'PlusAddressDto' 
+
+      # 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: InboxControllerApi#get_or_create_plus_address_by_full_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Organization Inboxes Paginated
     # List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). 
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/api/missed_sms_controller_api.rb

@@ -0,0 +1,221 @@
+=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 MissedSmsControllerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get all missed SMS messages in paginated format
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :phone_number Optional receiving phone number to filter missed SMS for
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @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 Optional filter missed SMS after given date time
+    # @option opts [DateTime] :before Optional filter missed SMS before given date time
+    # @option opts [String] :search Optional search filter
+    # @return [PageMissedSmsProjection]
+    def get_all_missed_sms_messages(opts = {})
+      data, _status_code, _headers = get_all_missed_sms_messages_with_http_info(opts)
+      data
+    end
+
+    # Get all missed SMS messages in paginated format
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :phone_number Optional receiving phone number to filter missed SMS for
+    # @option opts [Integer] :page Optional page index in list pagination
+    # @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 Optional filter missed SMS after given date time
+    # @option opts [DateTime] :before Optional filter missed SMS before given date time
+    # @option opts [String] :search Optional search filter
+    # @return [Array<(PageMissedSmsProjection, Integer, Hash)>] PageMissedSmsProjection data, response status code and response headers
+    def get_all_missed_sms_messages_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MissedSmsControllerApi.get_all_missed_sms_messages ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling MissedSmsControllerApi.get_all_missed_sms_messages, must be smaller than or equal to 100.'
+      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 = '/missed-sms'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'phoneNumber'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].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] || 'PageMissedSmsProjection' 
+
+      # 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: MissedSmsControllerApi#get_all_missed_sms_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get missed SMS count
+    # @param [Hash] opts the optional parameters
+    # @return [CountDto]
+    def get_missed_sms_count(opts = {})
+      data, _status_code, _headers = get_missed_sms_count_with_http_info(opts)
+      data
+    end
+
+    # Get missed SMS count
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
+    def get_missed_sms_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MissedSmsControllerApi.get_missed_sms_count ...'
+      end
+      # resource path
+      local_var_path = '/missed-sms/count'
+
+      # 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] || 'CountDto' 
+
+      # 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: MissedSmsControllerApi#get_missed_sms_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get missed SMS content
+    # Returns a missed SMS with full content.
+    # @param missed_sms_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [MissedSmsDto]
+    def get_missed_sms_message(missed_sms_id, opts = {})
+      data, _status_code, _headers = get_missed_sms_message_with_http_info(missed_sms_id, opts)
+      data
+    end
+
+    # Get missed SMS content
+    # Returns a missed SMS with full content.
+    # @param missed_sms_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MissedSmsDto, Integer, Hash)>] MissedSmsDto data, response status code and response headers
+    def get_missed_sms_message_with_http_info(missed_sms_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MissedSmsControllerApi.get_missed_sms_message ...'
+      end
+      # verify the required parameter 'missed_sms_id' is set
+      if @api_client.config.client_side_validation && missed_sms_id.nil?
+        fail ArgumentError, "Missing the required parameter 'missed_sms_id' when calling MissedSmsControllerApi.get_missed_sms_message"
+      end
+      # resource path
+      local_var_path = '/missed-sms/{missedSmsId}'.sub('{' + 'missedSmsId' + '}', CGI.escape(missed_sms_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] || 'MissedSmsDto' 
+
+      # 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: MissedSmsControllerApi#get_missed_sms_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end