mailslurp_client 17.1.0 → 17.3.0

data/lib/mailslurp_client/api/sms_controller_api.rb

@@ -605,6 +605,72 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Extract verification codes from an SMS
+    # Extract one-time passcodes and verification tokens from SMS body content. Deterministic `PATTERN` extraction is available now. Use method flags to control fallback behavior for QA.
+    # @param sms_id [String] ID of SMS to extract codes from
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExtractCodesOptions] :extract_codes_options 
+    # @return [ExtractCodesResult]
+    def get_sms_codes(sms_id, opts = {})
+      data, _status_code, _headers = get_sms_codes_with_http_info(sms_id, opts)
+      data
+    end
+
+    # Extract verification codes from an SMS
+    # Extract one-time passcodes and verification tokens from SMS body content. Deterministic `PATTERN` extraction is available now. Use method flags to control fallback behavior for QA.
+    # @param sms_id [String] ID of SMS to extract codes from
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExtractCodesOptions] :extract_codes_options 
+    # @return [Array<(ExtractCodesResult, Integer, Hash)>] ExtractCodesResult data, response status code and response headers
+    def get_sms_codes_with_http_info(sms_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SmsControllerApi.get_sms_codes ...'
+      end
+      # verify the required parameter 'sms_id' is set
+      if @api_client.config.client_side_validation && sms_id.nil?
+        fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.get_sms_codes"
+      end
+      # resource path
+      local_var_path = '/sms/{smsId}/codes'.sub('{' + 'smsId' + '}', CGI.escape(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(['*/*'])
+      # 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(opts[:'extract_codes_options']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ExtractCodesResult' 
+
+      # 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: SmsControllerApi#get_sms_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get SMS count
     # Get number of SMS
     # @param [Hash] opts the optional parameters
@@ -779,6 +845,131 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Mark all SMS messages as read or unread
+    # Sets read state for all SMS messages, optionally scoped to a single phone number. Use `read=false` to reset unread state in bulk.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :read  (default to true)
+    # @option opts [String] :phone_number_id 
+    # @return [nil]
+    def mark_all_sms_as_read(opts = {})
+      mark_all_sms_as_read_with_http_info(opts)
+      nil
+    end
+
+    # Mark all SMS messages as read or unread
+    # Sets read state for all SMS messages, optionally scoped to a single phone number. Use &#x60;read&#x3D;false&#x60; to reset unread state in bulk.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :read 
+    # @option opts [String] :phone_number_id 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def mark_all_sms_as_read_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SmsControllerApi.mark_all_sms_as_read ...'
+      end
+      # resource path
+      local_var_path = '/sms/read'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'read'] = opts[:'read'] if !opts[:'read'].nil?
+      query_params[:'phoneNumberId'] = opts[:'phone_number_id'] if !opts[:'phone_number_id'].nil?
+
+      # 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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SmsControllerApi#mark_all_sms_as_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mark an SMS as read or unread
+    # Sets read state for one SMS message. Useful when building custom inbox flows that need to restore unread state after inspection.
+    # @param sms_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :read  (default to true)
+    # @return [SmsDto]
+    def mark_sms_as_read(sms_id, opts = {})
+      data, _status_code, _headers = mark_sms_as_read_with_http_info(sms_id, opts)
+      data
+    end
+
+    # Mark an SMS as read or unread
+    # Sets read state for one SMS message. Useful when building custom inbox flows that need to restore unread state after inspection.
+    # @param sms_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :read 
+    # @return [Array<(SmsDto, Integer, Hash)>] SmsDto data, response status code and response headers
+    def mark_sms_as_read_with_http_info(sms_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SmsControllerApi.mark_sms_as_read ...'
+      end
+      # verify the required parameter 'sms_id' is set
+      if @api_client.config.client_side_validation && sms_id.nil?
+        fail ArgumentError, "Missing the required parameter 'sms_id' when calling SmsControllerApi.mark_sms_as_read"
+      end
+      # resource path
+      local_var_path = '/sms/{smsId}/read'.sub('{' + 'smsId' + '}', CGI.escape(sms_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'read'] = opts[:'read'] if !opts[:'read'].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] || 'SmsDto' 
+
+      # 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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SmsControllerApi#mark_sms_as_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send a reply to a received SMS message. Replies are sent from the receiving number.
     # Reply to an SMS message.
     # @param sms_id [String]