sms_works_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6a078a55fc73ea7a84275468e9cb2e5502f25f1
+  data.tar.gz: 431f36c6d46f3ef207ff4b245a970c208ac4feb0
+SHA512:
+  metadata.gz: dbe32eb8976deaf33e8cbb875acffc5fbb7f73db190db401a1705f3f1b80049b9626e2e314f8180e99d149738998710aee29b4e2fc3cf6af8abaccd2f61bf770
+  data.tar.gz: 088c81dbd94561679dd00f2a4a62fc016cccc3e9041e090123d00432097311ececfd1a87553942bb21910680f99b13d2354477e0195a310a61b06fb228f4abcb

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,120 @@
+# swagger_client
+
+SwaggerClient - the Ruby gem for the The SMS Works API
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/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:
+
+```shell
+gem build swagger_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# 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
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.thesmsworks.co.uk/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SwaggerClient::AuthApi* | [**key_secret**](docs/AuthApi.md#key_secret) | **GET** /auth/getApiKey | 
+*SwaggerClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /auth/token | 
+*SwaggerClient::BatchMessagesApi* | [**cancel_scheduled_batch_job**](docs/BatchMessagesApi.md#cancel_scheduled_batch_job) | **DELETE** /batches/schedule/{batchid} | 
+*SwaggerClient::BatchMessagesApi* | [**get_batch_by_id**](docs/BatchMessagesApi.md#get_batch_by_id) | **GET** /batch/{batchid} | 
+*SwaggerClient::BatchMessagesApi* | [**schedule_batch**](docs/BatchMessagesApi.md#schedule_batch) | **POST** /batch/schedule | 
+*SwaggerClient::BatchMessagesApi* | [**send_batch**](docs/BatchMessagesApi.md#send_batch) | **POST** /batch/send | 
+*SwaggerClient::MessagesApi* | [**cancel_scheduled_job**](docs/MessagesApi.md#cancel_scheduled_job) | **DELETE** /messages/schedule/{messageid} | 
+*SwaggerClient::MessagesApi* | [**get_message_by_id**](docs/MessagesApi.md#get_message_by_id) | **GET** /messages/{messageid} | 
+*SwaggerClient::MessagesApi* | [**get_messages**](docs/MessagesApi.md#get_messages) | **POST** /messages | 
+*SwaggerClient::MessagesApi* | [**schedule_message**](docs/MessagesApi.md#schedule_message) | **POST** /message/schedule | 
+*SwaggerClient::MessagesApi* | [**send_message**](docs/MessagesApi.md#send_message) | **POST** /message/send | 
+*SwaggerClient::UtilsApi* | [**hello**](docs/UtilsApi.md#hello) | **GET** /utils/hello | 
+
+
+## Documentation for Models
+
+ - [SwaggerClient::ApiKeyResponse](docs/ApiKeyResponse.md)
+ - [SwaggerClient::BatchMessage](docs/BatchMessage.md)
+ - [SwaggerClient::BatchMessageResponse](docs/BatchMessageResponse.md)
+ - [SwaggerClient::CancelledMessageResponse](docs/CancelledMessageResponse.md)
+ - [SwaggerClient::ErrorModel](docs/ErrorModel.md)
+ - [SwaggerClient::HelloWorldResponse](docs/HelloWorldResponse.md)
+ - [SwaggerClient::Login](docs/Login.md)
+ - [SwaggerClient::Message](docs/Message.md)
+ - [SwaggerClient::MessageResponse](docs/MessageResponse.md)
+ - [SwaggerClient::MessagesResponse](docs/MessagesResponse.md)
+ - [SwaggerClient::MessagesResponseMessages](docs/MessagesResponseMessages.md)
+ - [SwaggerClient::Query](docs/Query.md)
+ - [SwaggerClient::ScheduledBatchResponse](docs/ScheduledBatchResponse.md)
+ - [SwaggerClient::ScheduledMessageResponse](docs/ScheduledMessageResponse.md)
+ - [SwaggerClient::SendMessageResponse](docs/SendMessageResponse.md)
+ - [SwaggerClient::TokenResponse](docs/TokenResponse.md)
+ - [SwaggerClient::ExtendedErrorModel](docs/ExtendedErrorModel.md)
+
+
+## Documentation for Authorization
+
+
+### JWT
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ApiKeyResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ApiKeyResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | 
+**secret** | **String** |  | 
+
+

data/docs/AuthApi.md

@@ -0,0 +1,102 @@
+# SwaggerClient::AuthApi
+
+All URIs are relative to *https://api.thesmsworks.co.uk/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**key_secret**](AuthApi.md#key_secret) | **GET** /auth/getApiKey | 
+[**login**](AuthApi.md#login) | **POST** /auth/token | 
+
+
+# **key_secret**
+> ApiKeyResponse key_secret(customerid)
+
+
+
+Generates an API Key/Secret pair
+
+### Example
+```ruby
+# 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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customerid** | **String**| The Customer ID | 
+
+### Return type
+
+[**ApiKeyResponse**](ApiKeyResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+
+# **login**
+> TokenResponse login(credentials)
+
+
+
+Generates a Json Web Token
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AuthApi.new
+
+credentials = SwaggerClient::Login.new # Login | API Key & Secret
+
+
+begin
+  result = api_instance.login(credentials)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AuthApi->login: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **credentials** | [**Login**](Login.md)| API Key & Secret | 
+
+### Return type
+
+[**TokenResponse**](TokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+

data/docs/BatchMessage.md

@@ -0,0 +1,11 @@
+# SwaggerClient::BatchMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sender** | **String** | The sender of the message. Should be no longer than 11 characters for alphanumeric or 15 characters for numeric sender ID's. No spaces or special characters. | 
+**destinations** | **Array<String>** | Telephone numbers of each of the recipients | 
+**content** | **String** | Message to send to the recipient | 
+**schedule** | **String** | Date-time at which to send the batch. This is only used by the batch/schedule service. | 
+
+

data/docs/BatchMessageResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::BatchMessageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batchid** | **String** |  | 
+**status** | **String** |  | 
+
+

data/docs/BatchMessagesApi.md

@@ -0,0 +1,224 @@
+# SwaggerClient::BatchMessagesApi
+
+All URIs are relative to *https://api.thesmsworks.co.uk/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_scheduled_batch_job**](BatchMessagesApi.md#cancel_scheduled_batch_job) | **DELETE** /batches/schedule/{batchid} | 
+[**get_batch_by_id**](BatchMessagesApi.md#get_batch_by_id) | **GET** /batch/{batchid} | 
+[**schedule_batch**](BatchMessagesApi.md#schedule_batch) | **POST** /batch/schedule | 
+[**send_batch**](BatchMessagesApi.md#send_batch) | **POST** /batch/send | 
+
+
+# **cancel_scheduled_batch_job**
+> CancelledMessageResponse cancel_scheduled_batch_job(batchid)
+
+
+
+Cancels a scheduled SMS message
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: JWT
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::BatchMessagesApi.new
+
+batchid = "batchid_example" # String | The ID of the batch you would like returned
+
+
+begin
+  result = api_instance.cancel_scheduled_batch_job(batchid)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling BatchMessagesApi->cancel_scheduled_batch_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **batchid** | **String**| The ID of the batch you would like returned | 
+
+### Return type
+
+[**CancelledMessageResponse**](CancelledMessageResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+
+# **get_batch_by_id**
+> MessagesResponse get_batch_by_id(batchid)
+
+
+
+Retrieve all messages in a batch with the given batch ID
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: JWT
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::BatchMessagesApi.new
+
+batchid = "batchid_example" # String | The ID of the batch you would like returned
+
+
+begin
+  result = api_instance.get_batch_by_id(batchid)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling BatchMessagesApi->get_batch_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **batchid** | **String**| The ID of the batch you would like returned | 
+
+### Return type
+
+[**MessagesResponse**](MessagesResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+
+# **schedule_batch**
+> ScheduledBatchResponse schedule_batch(sms_message)
+
+
+
+Schedules a batch of SMS messages to be sent at the date-time you specify
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: JWT
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::BatchMessagesApi.new
+
+sms_message = SwaggerClient::BatchMessage.new # BatchMessage | Message properties
+
+
+begin
+  result = api_instance.schedule_batch(sms_message)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling BatchMessagesApi->schedule_batch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sms_message** | [**BatchMessage**](BatchMessage.md)| Message properties | 
+
+### Return type
+
+[**ScheduledBatchResponse**](ScheduledBatchResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+
+# **send_batch**
+> BatchMessageResponse send_batch(sms_message)
+
+
+
+Send a single SMS message to multiple recipients
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure API key authorization: JWT
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SwaggerClient::BatchMessagesApi.new
+
+sms_message = SwaggerClient::BatchMessage.new # BatchMessage | Message properties
+
+
+begin
+  result = api_instance.send_batch(sms_message)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling BatchMessagesApi->send_batch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sms_message** | [**BatchMessage**](BatchMessage.md)| Message properties | 
+
+### Return type
+
+[**BatchMessageResponse**](BatchMessageResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+