smspool 0.1.1

data/lib/smspool/api/sms_api.rb

@@ -0,0 +1,1214 @@
+=begin
+#SMSPool API
+
+#Every endpoint accepts its parameters as form fields (POST) or query parameters (GET).  Authenticate with your API key from https://www.smspool.net/my/settings, either as a bearer token (`Authorization: Bearer <key>`) or as a `key` parameter.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module SMSPool
+  class SMSApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Order SMS
+    # @param service [String] The service or number retrieved from the &#x60;Service List&#x60; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country The country in ISO format or number retrieved from the &#x60;Country List&#x60; endpoint
+    # @option opts [String] :pool The pool or number retrieved from the &#x60;Pool List&#x60; endpoint (optional)
+    # @option opts [Float] :max_price The max price you are willing to pay per number
+    # @option opts [Integer] :pricing_option Set to 0 if you&#39;d like the cheapest numbers, set to 1 for highest success rate
+    # @option opts [Integer] :quantity Quantity of numbers ordered
+    # @option opts [String] :areacode Areacodes you would like to include or exclude in JSON format
+    # @option opts [Integer] :exclude Set exclude to 1 if you would like to exclude all listed area codes.
+    # @option opts [Integer] :create_token Optional param; set to 1 if you&#39;d like to create a token link that anyone can access.
+    # @option opts [String] :activation_type Options: SMS, VOICE, FLASH. SMS will receive regular SMS, VOICE will receive phone calls that mentions the SMS and FLASH is for FLASH calls for verification.
+    # @option opts [Integer] :carrier Options: 1 or 2. Pick a carrier (only works for pool Foxtrot US)
+    # @option opts [Integer] :phonenumber In case you want to select a specific phone number to order
+    # @option opts [Integer] :software 
+    # @return [Object]
+    def purchase_sms(service, opts = {})
+      data, _status_code, _headers = purchase_sms_with_http_info(service, opts)
+      data
+    end
+
+    # Order SMS
+    # @param service [String] The service or number retrieved from the &#x60;Service List&#x60; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country The country in ISO format or number retrieved from the &#x60;Country List&#x60; endpoint
+    # @option opts [String] :pool The pool or number retrieved from the &#x60;Pool List&#x60; endpoint (optional)
+    # @option opts [Float] :max_price The max price you are willing to pay per number
+    # @option opts [Integer] :pricing_option Set to 0 if you&#39;d like the cheapest numbers, set to 1 for highest success rate
+    # @option opts [Integer] :quantity Quantity of numbers ordered
+    # @option opts [String] :areacode Areacodes you would like to include or exclude in JSON format
+    # @option opts [Integer] :exclude Set exclude to 1 if you would like to exclude all listed area codes.
+    # @option opts [Integer] :create_token Optional param; set to 1 if you&#39;d like to create a token link that anyone can access.
+    # @option opts [String] :activation_type Options: SMS, VOICE, FLASH. SMS will receive regular SMS, VOICE will receive phone calls that mentions the SMS and FLASH is for FLASH calls for verification.
+    # @option opts [Integer] :carrier Options: 1 or 2. Pick a carrier (only works for pool Foxtrot US)
+    # @option opts [Integer] :phonenumber In case you want to select a specific phone number to order
+    # @option opts [Integer] :software 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def purchase_sms_with_http_info(service, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.purchase_sms ...'
+      end
+      # verify the required parameter 'service' is set
+      if @api_client.config.client_side_validation && service.nil?
+        fail ArgumentError, "Missing the required parameter 'service' when calling SMSApi.purchase_sms"
+      end
+      # resource path
+      local_var_path = '/purchase/sms'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['service'] = service
+      form_params['country'] = opts[:'country'] if !opts[:'country'].nil?
+      form_params['pool'] = opts[:'pool'] if !opts[:'pool'].nil?
+      form_params['max_price'] = opts[:'max_price'] if !opts[:'max_price'].nil?
+      form_params['pricing_option'] = opts[:'pricing_option'] if !opts[:'pricing_option'].nil?
+      form_params['quantity'] = opts[:'quantity'] if !opts[:'quantity'].nil?
+      form_params['areacode'] = opts[:'areacode'] if !opts[:'areacode'].nil?
+      form_params['exclude'] = opts[:'exclude'] if !opts[:'exclude'].nil?
+      form_params['create_token'] = opts[:'create_token'] if !opts[:'create_token'].nil?
+      form_params['activation_type'] = opts[:'activation_type'] if !opts[:'activation_type'].nil?
+      form_params['carrier'] = opts[:'carrier'] if !opts[:'carrier'].nil?
+      form_params['phonenumber'] = opts[:'phonenumber'] if !opts[:'phonenumber'].nil?
+      form_params['software'] = opts[:'software'] if !opts[:'software'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.purchase_sms",
+        :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: SMSApi#purchase_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Active orders
+    # The recommended endpoint to retrieve your current active orders, this will display all your orders at the same time. We recommend using this endpoint to iterate through your active orders to retrieve your SMS messages.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def request_active(opts = {})
+      data, _status_code, _headers = request_active_with_http_info(opts)
+      data
+    end
+
+    # Active orders
+    # The recommended endpoint to retrieve your current active orders, this will display all your orders at the same time. We recommend using this endpoint to iterate through your active orders to retrieve your SMS messages.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def request_active_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.request_active ...'
+      end
+      # resource path
+      local_var_path = '/request/active'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.request_active",
+        :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: SMSApi#request_active\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Archive all orders
+    # This API endpoint is used to archive a request in the SMS Pool system. The HTTP POST request should be sent to `https://api.smspool.net/request/archive`.  ### Request Parameters  The \\`key\\` parameter is required for this endpoint, this is your API key.  ### Response  The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:  - `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure. - `message` (string): An optional message providing additional information about the request. In this case, the message is empty.       Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def request_archive(opts = {})
+      data, _status_code, _headers = request_archive_with_http_info(opts)
+      data
+    end
+
+    # Archive all orders
+    # This API endpoint is used to archive a request in the SMS Pool system. The HTTP POST request should be sent to &#x60;https://api.smspool.net/request/archive&#x60;.  ### Request Parameters  The \\&#x60;key\\&#x60; parameter is required for this endpoint, this is your API key.  ### Response  The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:  - &#x60;success&#x60; (integer): A flag indicating the success of the request. A value of 0 indicates failure. - &#x60;message&#x60; (string): An optional message providing additional information about the request. In this case, the message is empty.       Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def request_archive_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.request_archive ...'
+      end
+      # resource path
+      local_var_path = '/request/archive'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.request_archive",
+        :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: SMSApi#request_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Request available areacodes
+    # @param service [String] The service or number retrieved from the &#x60;Service List&#x60; endpoint
+    # @param country [String] The country in ISO format or number retrieved from the &#x60;Country List&#x60; endpoint
+    # @param pool [String] The pool or number retrieved from the &#x60;Pool List&#x60; endpoint (optional)
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def request_areacodes(service, country, pool, opts = {})
+      data, _status_code, _headers = request_areacodes_with_http_info(service, country, pool, opts)
+      data
+    end
+
+    # Request available areacodes
+    # @param service [String] The service or number retrieved from the &#x60;Service List&#x60; endpoint
+    # @param country [String] The country in ISO format or number retrieved from the &#x60;Country List&#x60; endpoint
+    # @param pool [String] The pool or number retrieved from the &#x60;Pool List&#x60; endpoint (optional)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def request_areacodes_with_http_info(service, country, pool, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.request_areacodes ...'
+      end
+      # verify the required parameter 'service' is set
+      if @api_client.config.client_side_validation && service.nil?
+        fail ArgumentError, "Missing the required parameter 'service' when calling SMSApi.request_areacodes"
+      end
+      # verify the required parameter 'country' is set
+      if @api_client.config.client_side_validation && country.nil?
+        fail ArgumentError, "Missing the required parameter 'country' when calling SMSApi.request_areacodes"
+      end
+      # verify the required parameter 'pool' is set
+      if @api_client.config.client_side_validation && pool.nil?
+        fail ArgumentError, "Missing the required parameter 'pool' when calling SMSApi.request_areacodes"
+      end
+      # resource path
+      local_var_path = '/request/areacodes'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['service'] = service
+      form_params['country'] = country
+      form_params['pool'] = pool
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.request_areacodes",
+        :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: SMSApi#request_areacodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Order History
+    # This API endpoint is used to retrieve the history of SMS requests. It is an HTTP POST request that should be made to the following URL: `https://api.smspool.net/request/history`.  The request requires the \\`key\\` parameter which is your API key.  The response returned by the API is a JSON array. Each element in the array represents a historical SMS request and contains the following properties:  - `cost`: The cost of the SMS request. - `order_code`: The order code associated with the SMS request. - `phonenumber`: The phone number to which the SMS was sent. - `code`: The code associated with the SMS request. - `full_code`: The full code associated with the SMS request. - `short_name`: The short name associated with the SMS request. - `service`: The service associated with the SMS request. - `status`: The status of the SMS request. - `pool`: The pool associated with the SMS request. - `timestamp`: The timestamp of the SMS request. - `completed_on`: The completion date of the SMS request. - `expiry`: The expiry time of the SMS request. - `time_left`: The time left for the SMS request to expire.       Please note that the values for the properties are not provided in the response example, so they may be empty or null.  The last execution of this API request returned a response with a status code of 200, indicating a successful execution. The response body contained an array of SMS request history objects.  Please refer to the API documentation for more details on how to use this endpoint and interpret the response.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :start Which row you&#39;d like to start from
+    # @option opts [Integer] :length Max length of all rows
+    # @option opts [String] :search Search query for phone number, order_code, service or country
+    # @return [Object]
+    def request_history(opts = {})
+      data, _status_code, _headers = request_history_with_http_info(opts)
+      data
+    end
+
+    # Order History
+    # This API endpoint is used to retrieve the history of SMS requests. It is an HTTP POST request that should be made to the following URL: &#x60;https://api.smspool.net/request/history&#x60;.  The request requires the \\&#x60;key\\&#x60; parameter which is your API key.  The response returned by the API is a JSON array. Each element in the array represents a historical SMS request and contains the following properties:  - &#x60;cost&#x60;: The cost of the SMS request. - &#x60;order_code&#x60;: The order code associated with the SMS request. - &#x60;phonenumber&#x60;: The phone number to which the SMS was sent. - &#x60;code&#x60;: The code associated with the SMS request. - &#x60;full_code&#x60;: The full code associated with the SMS request. - &#x60;short_name&#x60;: The short name associated with the SMS request. - &#x60;service&#x60;: The service associated with the SMS request. - &#x60;status&#x60;: The status of the SMS request. - &#x60;pool&#x60;: The pool associated with the SMS request. - &#x60;timestamp&#x60;: The timestamp of the SMS request. - &#x60;completed_on&#x60;: The completion date of the SMS request. - &#x60;expiry&#x60;: The expiry time of the SMS request. - &#x60;time_left&#x60;: The time left for the SMS request to expire.       Please note that the values for the properties are not provided in the response example, so they may be empty or null.  The last execution of this API request returned a response with a status code of 200, indicating a successful execution. The response body contained an array of SMS request history objects.  Please refer to the API documentation for more details on how to use this endpoint and interpret the response.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :start Which row you&#39;d like to start from
+    # @option opts [Integer] :length Max length of all rows
+    # @option opts [String] :search Search query for phone number, order_code, service or country
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def request_history_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.request_history ...'
+      end
+      # resource path
+      local_var_path = '/request/history'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['start'] = opts[:'start'] if !opts[:'start'].nil?
+      form_params['length'] = opts[:'length'] if !opts[:'length'].nil?
+      form_params['search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.request_history",
+        :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: SMSApi#request_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Activate SMS
+    # This endpoint will forcefully activate an SMS to set it available for future resends, please keep in mind that these orders are NOT eligible for a refund after activating them.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_activate(orderid, opts = {})
+      data, _status_code, _headers = sms_activate_with_http_info(orderid, opts)
+      data
+    end
+
+    # Activate SMS
+    # This endpoint will forcefully activate an SMS to set it available for future resends, please keep in mind that these orders are NOT eligible for a refund after activating them.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_activate_with_http_info(orderid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_activate ...'
+      end
+      # verify the required parameter 'orderid' is set
+      if @api_client.config.client_side_validation && orderid.nil?
+        fail ArgumentError, "Missing the required parameter 'orderid' when calling SMSApi.sms_activate"
+      end
+      # resource path
+      local_var_path = '/sms/activate'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['orderid'] = orderid
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_activate",
+        :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: SMSApi#sms_activate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # One-time stock for all services
+    # This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to `https://api.smspool.net/sms/stock`.  ### Request Parameters  The \\`key\\` parameter is required for this endpoint, this is your API key.  ### Response  The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:  - `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure.      - `message` (string): An optional message providing additional information about the request. In this case, the message is empty.       Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country Country retrieved from &#39;&#39;Country list\\\&quot; endpoint (optional)
+    # @option opts [String] :service Service retrieved from &#39;&#39;Service list\\\&quot; endpoint (optional)
+    # @option opts [String] :pool Pool retrieved from &#39;&#39;Pool list\\\&quot; endpoint (optional)
+    # @return [Object]
+    def sms_all_stock(opts = {})
+      data, _status_code, _headers = sms_all_stock_with_http_info(opts)
+      data
+    end
+
+    # One-time stock for all services
+    # This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to &#x60;https://api.smspool.net/sms/stock&#x60;.  ### Request Parameters  The \\&#x60;key\\&#x60; parameter is required for this endpoint, this is your API key.  ### Response  The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:  - &#x60;success&#x60; (integer): A flag indicating the success of the request. A value of 0 indicates failure.      - &#x60;message&#x60; (string): An optional message providing additional information about the request. In this case, the message is empty.       Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country Country retrieved from &#39;&#39;Country list\\\&quot; endpoint (optional)
+    # @option opts [String] :service Service retrieved from &#39;&#39;Service list\\\&quot; endpoint (optional)
+    # @option opts [String] :pool Pool retrieved from &#39;&#39;Pool list\\\&quot; endpoint (optional)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_all_stock_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_all_stock ...'
+      end
+      # resource path
+      local_var_path = '/sms/all_stock'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['country'] = opts[:'country'] if !opts[:'country'].nil?
+      form_params['service'] = opts[:'service'] if !opts[:'service'].nil?
+      form_params['pool'] = opts[:'pool'] if !opts[:'pool'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_all_stock",
+        :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: SMSApi#sms_all_stock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Cancel SMS
+    # # Cancel your SMS order  ## Responses  | **Success** | {\"success\":1} | | **Fail** | {\"success\":0} |
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :orderid 
+    # @option opts [String] :orderids 
+    # @option opts [Integer] :expiry 
+    # @option opts [Integer] :ban 
+    # @return [Object]
+    def sms_cancel(opts = {})
+      data, _status_code, _headers = sms_cancel_with_http_info(opts)
+      data
+    end
+
+    # Cancel SMS
+    # # Cancel your SMS order  ## Responses  | **Success** | {\&quot;success\&quot;:1} | | **Fail** | {\&quot;success\&quot;:0} |
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :orderid 
+    # @option opts [String] :orderids 
+    # @option opts [Integer] :expiry 
+    # @option opts [Integer] :ban 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_cancel_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_cancel ...'
+      end
+      # resource path
+      local_var_path = '/sms/cancel'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['orderid'] = opts[:'orderid'] if !opts[:'orderid'].nil?
+      form_params['orderids'] = opts[:'orderids'] if !opts[:'orderids'].nil?
+      form_params['expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?
+      form_params['ban'] = opts[:'ban'] if !opts[:'ban'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_cancel",
+        :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: SMSApi#sms_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Cancel All SMS
+    # # Cancel your SMS order  ## Responses  | **Success** | {\"success\":1} | | **Fail** | {\"success\":0} |
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_cancel_all(opts = {})
+      data, _status_code, _headers = sms_cancel_all_with_http_info(opts)
+      data
+    end
+
+    # Cancel All SMS
+    # # Cancel your SMS order  ## Responses  | **Success** | {\&quot;success\&quot;:1} | | **Fail** | {\&quot;success\&quot;:0} |
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_cancel_all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_cancel_all ...'
+      end
+      # resource path
+      local_var_path = '/sms/cancel_all'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_cancel_all",
+        :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: SMSApi#sms_cancel_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Check SMS
+    # You may run into ratelimits while using this endpoint for high rate requests, we recommend using /request/active instead as it will list all your orders at the same time.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_check(orderid, opts = {})
+      data, _status_code, _headers = sms_check_with_http_info(orderid, opts)
+      data
+    end
+
+    # Check SMS
+    # You may run into ratelimits while using this endpoint for high rate requests, we recommend using /request/active instead as it will list all your orders at the same time.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_check_with_http_info(orderid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_check ...'
+      end
+      # verify the required parameter 'orderid' is set
+      if @api_client.config.client_side_validation && orderid.nil?
+        fail ArgumentError, "Missing the required parameter 'orderid' when calling SMSApi.sms_check"
+      end
+      # resource path
+      local_var_path = '/sms/check'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['orderid'] = orderid
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_check",
+        :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: SMSApi#sms_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Check Resend
+    # Check if the order can be resent or not.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_check_resend(orderid, opts = {})
+      data, _status_code, _headers = sms_check_resend_with_http_info(orderid, opts)
+      data
+    end
+
+    # Check Resend
+    # Check if the order can be resent or not.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_check_resend_with_http_info(orderid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_check_resend ...'
+      end
+      # verify the required parameter 'orderid' is set
+      if @api_client.config.client_side_validation && orderid.nil?
+        fail ArgumentError, "Missing the required parameter 'orderid' when calling SMSApi.sms_check_resend"
+      end
+      # resource path
+      local_var_path = '/sms/check_resend'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['orderid'] = orderid
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_check_resend",
+        :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: SMSApi#sms_check_resend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Clear SMS Cache
+    # # Clear your previous SMS cache to allocate previous numbers again  ## Responses  | **Success** | {\"success\":1} |   | **Fail** | {\"success\":0} |
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_clear_cache(opts = {})
+      data, _status_code, _headers = sms_clear_cache_with_http_info(opts)
+      data
+    end
+
+    # Clear SMS Cache
+    # # Clear your previous SMS cache to allocate previous numbers again  ## Responses  | **Success** | {\&quot;success\&quot;:1} |   | **Fail** | {\&quot;success\&quot;:0} |
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_clear_cache_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_clear_cache ...'
+      end
+      # resource path
+      local_var_path = '/sms/clear_cache'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_clear_cache",
+        :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: SMSApi#sms_clear_cache\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Missed SMS
+    # Some messages arrive on a number from your one-time orders but cannot finish the order, such as Ticketmaster and Seated codes or Hark reward payouts. This returns those messages, the same ones the Missed SMS tool on the website shows. Only numbers from pool Foxtrot are covered.  The newest messages come first. `url`, `code` and `email` hold the first link, code and email address found in the message, or an empty string.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :phonenumber Only return messages for this number, including the country code. Leave it out for all your numbers.
+    # @option opts [Integer] :limit Maximum number of messages. Defaults to 100, at most 500.
+    # @return [Object]
+    def sms_missed(opts = {})
+      data, _status_code, _headers = sms_missed_with_http_info(opts)
+      data
+    end
+
+    # Missed SMS
+    # Some messages arrive on a number from your one-time orders but cannot finish the order, such as Ticketmaster and Seated codes or Hark reward payouts. This returns those messages, the same ones the Missed SMS tool on the website shows. Only numbers from pool Foxtrot are covered.  The newest messages come first. &#x60;url&#x60;, &#x60;code&#x60; and &#x60;email&#x60; hold the first link, code and email address found in the message, or an empty string.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :phonenumber Only return messages for this number, including the country code. Leave it out for all your numbers.
+    # @option opts [Integer] :limit Maximum number of messages. Defaults to 100, at most 500.
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_missed_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_missed ...'
+      end
+      # resource path
+      local_var_path = '/sms/missed'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['phonenumber'] = opts[:'phonenumber'] if !opts[:'phonenumber'].nil?
+      form_params['limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_missed",
+        :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: SMSApi#sms_missed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reactivate SMS
+    # This endpoint will reactivate an order, please keep in mind that these orders are NOT eligible for a refund after activating them.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_reactivate(orderid, opts = {})
+      data, _status_code, _headers = sms_reactivate_with_http_info(orderid, opts)
+      data
+    end
+
+    # Reactivate SMS
+    # This endpoint will reactivate an order, please keep in mind that these orders are NOT eligible for a refund after activating them.
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_reactivate_with_http_info(orderid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_reactivate ...'
+      end
+      # verify the required parameter 'orderid' is set
+      if @api_client.config.client_side_validation && orderid.nil?
+        fail ArgumentError, "Missing the required parameter 'orderid' when calling SMSApi.sms_reactivate"
+      end
+      # resource path
+      local_var_path = '/sms/reactivate'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['orderid'] = orderid
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_reactivate",
+        :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: SMSApi#sms_reactivate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Resend
+    # # Resend  Resend the order. Keep in mind that some pools will have a charge per resend. You can see whether the resend will have a charge using the \"Check Resend\" endpoint  ## Responses  | **Success** | {\"success\":1,\"message\":\"Number has been requested again\",\"resend\":0} |   | **Fail** | {\"success\":0,\"message\":\"Phonenumber could not be requested again, try later again.\",\"resend\":0} |
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_resend(orderid, opts = {})
+      data, _status_code, _headers = sms_resend_with_http_info(orderid, opts)
+      data
+    end
+
+    # Resend
+    # # Resend  Resend the order. Keep in mind that some pools will have a charge per resend. You can see whether the resend will have a charge using the \&quot;Check Resend\&quot; endpoint  ## Responses  | **Success** | {\&quot;success\&quot;:1,\&quot;message\&quot;:\&quot;Number has been requested again\&quot;,\&quot;resend\&quot;:0} |   | **Fail** | {\&quot;success\&quot;:0,\&quot;message\&quot;:\&quot;Phonenumber could not be requested again, try later again.\&quot;,\&quot;resend\&quot;:0} |
+    # @param orderid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_resend_with_http_info(orderid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_resend ...'
+      end
+      # verify the required parameter 'orderid' is set
+      if @api_client.config.client_side_validation && orderid.nil?
+        fail ArgumentError, "Missing the required parameter 'orderid' when calling SMSApi.sms_resend"
+      end
+      # resource path
+      local_var_path = '/sms/resend'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['orderid'] = orderid
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_resend",
+        :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: SMSApi#sms_resend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # One-time SMS stock
+    # This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to `https://api.smspool.net/sms/stock`.  ### Request Parameters  The \\`key\\` parameter is required for this endpoint, this is your API key.  ### Response  The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:  - `success` (integer): A flag indicating the success of the request. A value of 0 indicates failure.      - `message` (string): An optional message providing additional information about the request. In this case, the message is empty.       Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.
+    # @param country [String] Country retrieved from &#39;&#39;Country list\\\&quot; endpoint
+    # @param service [String] Service retrieved from &#39;&#39;Service list\\\&quot; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :pool Pool retrieved from &#39;&#39;Pool list\\\&quot; endpoint
+    # @option opts [Integer] :include_price 
+    # @return [Object]
+    def sms_stock(country, service, opts = {})
+      data, _status_code, _headers = sms_stock_with_http_info(country, service, opts)
+      data
+    end
+
+    # One-time SMS stock
+    # This API endpoint is used to retrieve one-time SMS stock in the SMSPool system. The HTTP POST request should be sent to &#x60;https://api.smspool.net/sms/stock&#x60;.  ### Request Parameters  The \\&#x60;key\\&#x60; parameter is required for this endpoint, this is your API key.  ### Response  The response for this API endpoint will have a status code of 200, indicating a successful request. The response body will be in JSON format and will contain the following properties:  - &#x60;success&#x60; (integer): A flag indicating the success of the request. A value of 0 indicates failure.      - &#x60;message&#x60; (string): An optional message providing additional information about the request. In this case, the message is empty.       Please note that the response may contain additional properties not mentioned here, but they can be ignored for the purpose of this documentation.
+    # @param country [String] Country retrieved from &#39;&#39;Country list\\\&quot; endpoint
+    # @param service [String] Service retrieved from &#39;&#39;Service list\\\&quot; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :pool Pool retrieved from &#39;&#39;Pool list\\\&quot; endpoint
+    # @option opts [Integer] :include_price 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_stock_with_http_info(country, service, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_stock ...'
+      end
+      # verify the required parameter 'country' is set
+      if @api_client.config.client_side_validation && country.nil?
+        fail ArgumentError, "Missing the required parameter 'country' when calling SMSApi.sms_stock"
+      end
+      # verify the required parameter 'service' is set
+      if @api_client.config.client_side_validation && service.nil?
+        fail ArgumentError, "Missing the required parameter 'service' when calling SMSApi.sms_stock"
+      end
+      # resource path
+      local_var_path = '/sms/stock'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['country'] = country
+      form_params['service'] = service
+      form_params['pool'] = opts[:'pool'] if !opts[:'pool'].nil?
+      form_params['include_price'] = opts[:'include_price'] if !opts[:'include_price'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_stock",
+        :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: SMSApi#sms_stock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Unarchive order
+    # Move an archived order back to your active orders, so it shows up in **Active orders** and on your dashboard again. Use **Archive all orders** to archive them.
+    # @param orderid [String] The order ID retrieved from /purchase/sms
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def sms_unarchive(orderid, opts = {})
+      data, _status_code, _headers = sms_unarchive_with_http_info(orderid, opts)
+      data
+    end
+
+    # Unarchive order
+    # Move an archived order back to your active orders, so it shows up in **Active orders** and on your dashboard again. Use **Archive all orders** to archive them.
+    # @param orderid [String] The order ID retrieved from /purchase/sms
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def sms_unarchive_with_http_info(orderid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SMSApi.sms_unarchive ...'
+      end
+      # verify the required parameter 'orderid' is set
+      if @api_client.config.client_side_validation && orderid.nil?
+        fail ArgumentError, "Missing the required parameter 'orderid' when calling SMSApi.sms_unarchive"
+      end
+      # resource path
+      local_var_path = '/sms/unarchive'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['orderid'] = orderid
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SMSApi.sms_unarchive",
+        :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: SMSApi#sms_unarchive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end