Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

swagger_client

SwaggerClient - the Ruby gem for the The SMS Works API

The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed messages are refunded.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

api_instance = SwaggerClient::AuthApi.new

customerid = "customerid_example" # String | The Customer ID


begin
  result = api_instance.key_secret(customerid)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling AuthApi->key_secret: #{e}"
end

Test calls in Postman

Run in Postman

Documentation for API Endpoints

All URIs are relative to https://api.thesmsworks.co.uk/v1

Class Method HTTP request Description
SwaggerClient::AuthApi key_secret GET /auth/getApiKey
SwaggerClient::AuthApi login POST /auth/token
SwaggerClient::BatchMessagesApi cancel_scheduled_batch_job DELETE /batches/schedule/{batchid}
SwaggerClient::BatchMessagesApi get_batch_by_id GET /batch/{batchid}
SwaggerClient::BatchMessagesApi schedule_batch POST /batch/schedule
SwaggerClient::BatchMessagesApi send_batch POST /batch/send
SwaggerClient::MessagesApi cancel_scheduled_job DELETE /messages/schedule/{messageid}
SwaggerClient::MessagesApi get_inbox_messages POST /messages/inbox
SwaggerClient::MessagesApi get_message_by_id GET /messages/{messageid}
SwaggerClient::MessagesApi get_messages POST /messages
SwaggerClient::MessagesApi schedule_message POST /message/schedule
SwaggerClient::MessagesApi send_message POST /message/send
SwaggerClient::UtilsApi test GET /utils/test

Documentation for Models

Documentation for Authorization

JWT

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

Ruby client SDK for The SMS Works API

Resources

Releases

No releases published

Packages

No packages published