smspool 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6715cace4f206de2bed3308dfb5b64b91d052adce7b110d87c4c893d972863db
+  data.tar.gz: 70e3be6c9c1efccf92cad0d1e8a7b6653b9abb7b0f42a3ec588eeb588a2a6085
+SHA512:
+  metadata.gz: 63651006706c9509cbda8399d4098ca75c4c85b74a5fc1b7051f0dcf82d9acc0177efcd4ad5a05e185565fbd2dec175f995d8375a1fea265a6b1006217c53a1a
+  data.tar.gz: ba8eea412e10ec4b2281912e77f458fa196dc4b681820c90a6ea81ddcc2cf84fb9ccdea3684f125c0b88eb59e865123d8b975d588bb84a1be0b52ada13734587

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SMSPool
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# SMSPool Ruby SDK
+
+Official Ruby client for the [SMSPool API](https://api.smspool.net/docs): one-time SMS
+verification numbers, rentals, pre-orders, eSIMs and more.
+
+Package: [`smspool`](https://rubygems.org/gems/smspool) on RubyGems.
+
+## Install
+
+```bash
+gem install smspool
+```
+
+## Quick start
+
+Get your API key from [your settings page](https://www.smspool.net/my/settings).
+
+```ruby
+require "smspool"
+
+SMSPool.configure { |c| c.access_token = "YOUR_API_KEY" }
+p SMSPool::InformationApi.new.request_balance
+countries = SMSPool::InformationApi.new.country_retrieve_all
+order = SMSPool::SMSApi.new.purchase_sms("1", country: "US")
+```
+
+Errors (HTTP 4xx/5xx) raise `SMSPool::ApiError`, with `code` and `response_body`.
+
+## Calling endpoints
+
+Every endpoint in the [API reference](https://api.smspool.net/docs) is a method named after
+its path, on the class for its section: `/sms/check` is `sms_check` on `SMSApi`. Endpoints that need
+your API key send it as a bearer token.
+
+Responses are returned as decoded JSON exactly as the API sends them: many endpoints answer
+`200` with `"success": 0` and a `message` when a request is refused, so check `success`.
+
+- Generated reference for every method and parameter: [`docs/`](docs/)
+- API reference with examples: https://api.smspool.net/docs
+
+## How this SDK is made
+
+The code is generated from the API's OpenAPI spec
+([openapi.json](https://api.smspool.net/openapi.json)) with
+[OpenAPI Generator](https://openapi-generator.tech). Do not edit generated files by hand:
+a workflow regenerates them every week and opens a pull request when the API changed.
+Hand-written files are listed in `.openapi-generator-ignore`.
+
+## Releasing (maintainers)
+
+1. Set the new version in `openapi-generator.yaml` (`gemVersion`).
+2. Run `scripts/generate.sh` (needs Docker) and `scripts/smoke.sh`, then commit.
+3. Tag and push: `git tag vX.Y.Z && git push origin vX.Y.Z`.
+
+The Release workflow checks the tag against the version, runs the smoke test and publishes.
+RubyGems uses trusted publishing (no token): the gem's publisher is this repo's
+`release.yml` workflow in the `release` environment.
+
+## License
+
+MIT

data/lib/smspool/api/business_api.rb

@@ -0,0 +1,300 @@
+=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 BusinessApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Register user
+    # @param username [String] 
+    # @param password [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :daily_spend_limit Optional daily spend cap in USD. Omit for no limit.
+    # @return [Object]
+    def business_create(username, password, opts = {})
+      data, _status_code, _headers = business_create_with_http_info(username, password, opts)
+      data
+    end
+
+    # Register user
+    # @param username [String] 
+    # @param password [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :daily_spend_limit Optional daily spend cap in USD. Omit for no limit.
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def business_create_with_http_info(username, password, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BusinessApi.business_create ...'
+      end
+      # verify the required parameter 'username' is set
+      if @api_client.config.client_side_validation && username.nil?
+        fail ArgumentError, "Missing the required parameter 'username' when calling BusinessApi.business_create"
+      end
+      # verify the required parameter 'password' is set
+      if @api_client.config.client_side_validation && password.nil?
+        fail ArgumentError, "Missing the required parameter 'password' when calling BusinessApi.business_create"
+      end
+      # resource path
+      local_var_path = '/business/create'
+
+      # 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['username'] = username
+      form_params['password'] = password
+      form_params['daily_spend_limit'] = opts[:'daily_spend_limit'] if !opts[:'daily_spend_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 => :"BusinessApi.business_create",
+        :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: BusinessApi#business_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # History
+    # @param id [Integer] User ID retrievd from &#x60;Retrieve users&#x60; endpoint
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def business_user_history(id, opts = {})
+      data, _status_code, _headers = business_user_history_with_http_info(id, opts)
+      data
+    end
+
+    # History
+    # @param id [Integer] User ID retrievd from &#x60;Retrieve users&#x60; endpoint
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def business_user_history_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BusinessApi.business_user_history ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BusinessApi.business_user_history"
+      end
+      # resource path
+      local_var_path = '/business/user/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['id'] = id
+
+      # 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 => :"BusinessApi.business_user_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: BusinessApi#business_user_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update
+    # @param id [Integer] User ID retrievd from &#x60;Retrieve users&#x60; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :password Leave empty if you do not wish to update the password
+    # @option opts [Float] :balance Leave empty if you do not wish to update the balance, sets the balance by the requested value
+    # @option opts [Integer] :active Disable/enable user account (optional)
+    # @option opts [Float] :daily_spend_limit Daily spend cap in USD. Leave empty to leave unchanged, send -1 to remove the cap, 0 to block all spending.
+    # @return [Object]
+    def business_user_update(id, opts = {})
+      data, _status_code, _headers = business_user_update_with_http_info(id, opts)
+      data
+    end
+
+    # Update
+    # @param id [Integer] User ID retrievd from &#x60;Retrieve users&#x60; endpoint
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :password Leave empty if you do not wish to update the password
+    # @option opts [Float] :balance Leave empty if you do not wish to update the balance, sets the balance by the requested value
+    # @option opts [Integer] :active Disable/enable user account (optional)
+    # @option opts [Float] :daily_spend_limit Daily spend cap in USD. Leave empty to leave unchanged, send -1 to remove the cap, 0 to block all spending.
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def business_user_update_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BusinessApi.business_user_update ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BusinessApi.business_user_update"
+      end
+      # resource path
+      local_var_path = '/business/user/update'
+
+      # 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['id'] = id
+      form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
+      form_params['balance'] = opts[:'balance'] if !opts[:'balance'].nil?
+      form_params['active'] = opts[:'active'] if !opts[:'active'].nil?
+      form_params['daily_spend_limit'] = opts[:'daily_spend_limit'] if !opts[:'daily_spend_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 => :"BusinessApi.business_user_update",
+        :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: BusinessApi#business_user_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve users
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def business_users(opts = {})
+      data, _status_code, _headers = business_users_with_http_info(opts)
+      data
+    end
+
+    # Retrieve users
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def business_users_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BusinessApi.business_users ...'
+      end
+      # resource path
+      local_var_path = '/business/users'
+
+      # 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 => :"BusinessApi.business_users",
+        :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: BusinessApi#business_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/smspool/api/carrier_api.rb

@@ -0,0 +1,91 @@
+=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 CarrierApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Lookup
+    # This API endpoint is used to perform a paid lookup for a phone number. The request is sent via an HTTP POST method to the following URL: `https://api.smspool.net/carrier/paid_lookup`  ``` json {   \"success\": true,   \"phonenumber\": \"\",   \"country\": \"\",   \"carrier\": \"\",   \"carrier_type\": \"\",   \"charge\": 0 }   ```  The `success` field indicates whether the lookup was successful or not. The `phonenumber` field represents the phone number for which the lookup was performed. The `country` field indicates the country associated with the phone number. The `carrier` field provides the name of the carrier associated with the phone number. The `carrier_type` field specifies the type of carrier. The `charge` field represents the cost charged for the lookup operation.  Please note that specific values for `phonenumber`, `country`, `carrier`, and `carrier_type` were not provided in the response, and the `charge` field had a value of 0.  To use this endpoint, send an HTTP POST request to the provided URL with the necessary parameters. The request should include the phone number for which you want to perform the lookup. The response will contain the details of the carrier and associated information.  Make sure to handle any errors that may occur during the lookup process and check the `success` field in the response to determine the outcome of the operation.
+    # @param phonenumber [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def carrier_paid_lookup(phonenumber, opts = {})
+      data, _status_code, _headers = carrier_paid_lookup_with_http_info(phonenumber, opts)
+      data
+    end
+
+    # Lookup
+    # This API endpoint is used to perform a paid lookup for a phone number. The request is sent via an HTTP POST method to the following URL: &#x60;https://api.smspool.net/carrier/paid_lookup&#x60;  &#x60;&#x60;&#x60; json {   \&quot;success\&quot;: true,   \&quot;phonenumber\&quot;: \&quot;\&quot;,   \&quot;country\&quot;: \&quot;\&quot;,   \&quot;carrier\&quot;: \&quot;\&quot;,   \&quot;carrier_type\&quot;: \&quot;\&quot;,   \&quot;charge\&quot;: 0 }   &#x60;&#x60;&#x60;  The &#x60;success&#x60; field indicates whether the lookup was successful or not. The &#x60;phonenumber&#x60; field represents the phone number for which the lookup was performed. The &#x60;country&#x60; field indicates the country associated with the phone number. The &#x60;carrier&#x60; field provides the name of the carrier associated with the phone number. The &#x60;carrier_type&#x60; field specifies the type of carrier. The &#x60;charge&#x60; field represents the cost charged for the lookup operation.  Please note that specific values for &#x60;phonenumber&#x60;, &#x60;country&#x60;, &#x60;carrier&#x60;, and &#x60;carrier_type&#x60; were not provided in the response, and the &#x60;charge&#x60; field had a value of 0.  To use this endpoint, send an HTTP POST request to the provided URL with the necessary parameters. The request should include the phone number for which you want to perform the lookup. The response will contain the details of the carrier and associated information.  Make sure to handle any errors that may occur during the lookup process and check the &#x60;success&#x60; field in the response to determine the outcome of the operation.
+    # @param phonenumber [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def carrier_paid_lookup_with_http_info(phonenumber, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CarrierApi.carrier_paid_lookup ...'
+      end
+      # verify the required parameter 'phonenumber' is set
+      if @api_client.config.client_side_validation && phonenumber.nil?
+        fail ArgumentError, "Missing the required parameter 'phonenumber' when calling CarrierApi.carrier_paid_lookup"
+      end
+      # resource path
+      local_var_path = '/carrier/paid_lookup'
+
+      # 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'] = phonenumber
+
+      # 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 => :"CarrierApi.carrier_paid_lookup",
+        :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: CarrierApi#carrier_paid_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end