smspool 0.1.1

data/lib/smspool/api/information_api.rb

@@ -0,0 +1,479 @@
+=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 InformationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Country list
+    # This API endpoint is used to retrieve the full country list for SMSPool requests. It sends an HTTP GET request to the URL `https://api.smspool.net/country/retrieve_all`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :show_all 
+    # @return [Object]
+    def country_retrieve_all(opts = {})
+      data, _status_code, _headers = country_retrieve_all_with_http_info(opts)
+      data
+    end
+
+    # Country list
+    # This API endpoint is used to retrieve the full country list for SMSPool requests. It sends an HTTP GET request to the URL &#x60;https://api.smspool.net/country/retrieve_all&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :show_all 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def country_retrieve_all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InformationApi.country_retrieve_all ...'
+      end
+      # resource path
+      local_var_path = '/country/retrieve_all'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'show_all'] = opts[:'show_all'] if !opts[:'show_all'].nil?
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"InformationApi.country_retrieve_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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InformationApi#country_retrieve_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Pool list
+    # This API endpoint is used to retrieve a list of our active pools for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/pool/retrieve_all`.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def pool_retrieve_all(opts = {})
+      data, _status_code, _headers = pool_retrieve_all_with_http_info(opts)
+      data
+    end
+
+    # Pool list
+    # This API endpoint is used to retrieve a list of our active pools for SMSPool requests. It sends an HTTP POST request to the URL &#x60;https://api.smspool.net/pool/retrieve_all&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def pool_retrieve_all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InformationApi.pool_retrieve_all ...'
+      end
+      # resource path
+      local_var_path = '/pool/retrieve_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] || []
+
+      new_options = opts.merge(
+        :operation => :"InformationApi.pool_retrieve_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: InformationApi#pool_retrieve_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Suggested Pools
+    # This API endpoint is used to retrieve suggested pools for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/pool/retrieve_valid`.  Please use either the service ID, or the service name as service param.
+    # @param service [String] Service retrieved from &#39;&#39;Service list\\\&quot; endpoint
+    # @param country [String] Country retrieved from &#39;&#39;Country list\\\&quot; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :web Return array format
+    # @option opts [String] :include_stock 
+    # @return [Object]
+    def pool_retrieve_valid(service, country, opts = {})
+      data, _status_code, _headers = pool_retrieve_valid_with_http_info(service, country, opts)
+      data
+    end
+
+    # Suggested Pools
+    # This API endpoint is used to retrieve suggested pools for SMSPool requests. It sends an HTTP POST request to the URL &#x60;https://api.smspool.net/pool/retrieve_valid&#x60;.  Please use either the service ID, or the service name as service param.
+    # @param service [String] Service retrieved from &#39;&#39;Service list\\\&quot; endpoint
+    # @param country [String] Country retrieved from &#39;&#39;Country list\\\&quot; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :web Return array format
+    # @option opts [String] :include_stock 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def pool_retrieve_valid_with_http_info(service, country, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InformationApi.pool_retrieve_valid ...'
+      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 InformationApi.pool_retrieve_valid"
+      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 InformationApi.pool_retrieve_valid"
+      end
+      # resource path
+      local_var_path = '/pool/retrieve_valid'
+
+      # 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['web'] = opts[:'web'] if !opts[:'web'].nil?
+      form_params['include_stock'] = opts[:'include_stock'] if !opts[:'include_stock'].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 => :"InformationApi.pool_retrieve_valid",
+        :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: InformationApi#pool_retrieve_valid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Balance
+    # This HTTP POST request is used to retrieve the balance for a specific SMSPool. The request is sent to the URL `https://api.smspool.net/request/balance`.  ### Request Parameters  This request require the \\`key\\` param which is your API key  ### Response  The response to this request will have a status code of 200 if the request is successful. The response body will be in JSON format and will include a `balance` field. However, the last execution of this request returned an empty string for the `balance` field.  Please note that the actual value of the `balance` field may vary depending on the user and its configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def request_balance(opts = {})
+      data, _status_code, _headers = request_balance_with_http_info(opts)
+      data
+    end
+
+    # Balance
+    # This HTTP POST request is used to retrieve the balance for a specific SMSPool. The request is sent to the URL &#x60;https://api.smspool.net/request/balance&#x60;.  ### Request Parameters  This request require the \\&#x60;key\\&#x60; param which is your API key  ### Response  The response to this request will have a status code of 200 if the request is successful. The response body will be in JSON format and will include a &#x60;balance&#x60; field. However, the last execution of this request returned an empty string for the &#x60;balance&#x60; field.  Please note that the actual value of the &#x60;balance&#x60; field may vary depending on the user and its configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def request_balance_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InformationApi.request_balance ...'
+      end
+      # resource path
+      local_var_path = '/request/balance'
+
+      # 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 => :"InformationApi.request_balance",
+        :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: InformationApi#request_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve country success rates per service
+    # This API endpoint is used to retrieve success per country for SMSPool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/request/success_rate`.  Please use either the service ID, or the service name as service param.
+    # @param service [String] Service name or service ID which can be retrieved at the /service/retrieve_all endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country Country name or country ID which can be retrieved at the /country/retrieve_all endpoint
+    # @return [Object]
+    def request_success_rate(service, opts = {})
+      data, _status_code, _headers = request_success_rate_with_http_info(service, opts)
+      data
+    end
+
+    # Retrieve country success rates per service
+    # This API endpoint is used to retrieve success per country for SMSPool requests. It sends an HTTP POST request to the URL &#x60;https://api.smspool.net/request/success_rate&#x60;.  Please use either the service ID, or the service name as service param.
+    # @param service [String] Service name or service ID which can be retrieved at the /service/retrieve_all endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country Country name or country ID which can be retrieved at the /country/retrieve_all endpoint
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def request_success_rate_with_http_info(service, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InformationApi.request_success_rate ...'
+      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 InformationApi.request_success_rate"
+      end
+      # resource path
+      local_var_path = '/request/success_rate'
+
+      # 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?
+
+      # 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 => :"InformationApi.request_success_rate",
+        :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: InformationApi#request_success_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Suggested Countries
+    # This API endpoint is used to retrieve suggested countries for SMS pool requests. It sends an HTTP POST request to the URL `https://api.smspool.net/request/suggested_countries`.  Please use either the service ID, or the service name as service param.
+    # @param service [String] Service name or service ID which can be retrieved at the /service/retrieve_all endpoint
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def request_suggested_countries(service, opts = {})
+      data, _status_code, _headers = request_suggested_countries_with_http_info(service, opts)
+      data
+    end
+
+    # Suggested Countries
+    # This API endpoint is used to retrieve suggested countries for SMS pool requests. It sends an HTTP POST request to the URL &#x60;https://api.smspool.net/request/suggested_countries&#x60;.  Please use either the service ID, or the service name as service param.
+    # @param service [String] Service name or service ID which can be retrieved at the /service/retrieve_all endpoint
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def request_suggested_countries_with_http_info(service, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InformationApi.request_suggested_countries ...'
+      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 InformationApi.request_suggested_countries"
+      end
+      # resource path
+      local_var_path = '/request/suggested_countries'
+
+      # 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
+
+      # 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 => :"InformationApi.request_suggested_countries",
+        :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: InformationApi#request_suggested_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Service list
+    # This API endpoint is used to retrieve the full service list for SMSPool requests. It sends an HTTP GET request to the URL `https://api.smspool.net/service/retrieve_all`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country 
+    # @return [Object]
+    def service_retrieve_all(opts = {})
+      data, _status_code, _headers = service_retrieve_all_with_http_info(opts)
+      data
+    end
+
+    # Service list
+    # This API endpoint is used to retrieve the full service list for SMSPool requests. It sends an HTTP GET request to the URL &#x60;https://api.smspool.net/service/retrieve_all&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :country 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def service_retrieve_all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InformationApi.service_retrieve_all ...'
+      end
+      # resource path
+      local_var_path = '/service/retrieve_all'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"InformationApi.service_retrieve_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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InformationApi#service_retrieve_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end