sms_works_sdk 1.0.0

data/docs/CancelledMessageResponse.md

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

data/docs/ErrorModel.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | 
+**code** | **Integer** |  | 
+
+

data/docs/ExtendedErrorModel.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ExtendedErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | 
+**code** | **Integer** |  | 
+**error_code** | **Float** |  | 
+
+

data/docs/HelloWorldResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::HelloWorldResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | 
+
+

data/docs/Login.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Login
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerid** | **String** | Your customer ID, available from your account area at https://thesmsworks.co.uk/user/login | [optional] 
+**key** | **String** | API Key | [optional] 
+**secret** | **String** | API Secret | [optional] 
+
+

data/docs/Message.md

@@ -0,0 +1,12 @@
+# SwaggerClient::Message
+
+## 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. | 
+**destination** | **String** | Telephone number of the recipient | 
+**content** | **String** | Message to send to the recipient. Content can be up to 640 characters in length. You will be charged 1 credit for each 160 characters, up to a maximum of 4 credits. Messages sent to numbers registered outside the UK will be charged double credits (i.e. 2 credits per 160 characters, up to maximum of 8 credits). | 
+**schedule** | **String** | Date at which to send the message. This is only used by the message/schedule service and can be left empty for other services. | 
+**tag** | **String** | An identifying label for the message, which you can use to filter and report on messages you've sent later. Ideal for campaigns. | [optional] 
+
+

data/docs/MessageResponse.md

@@ -0,0 +1,19 @@
+# SwaggerClient::MessageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batchid** | **String** |  | 
+**content** | **String** |  | 
+**created** | **String** |  | 
+**customerid** | **String** |  | 
+**destination** | **Float** |  | 
+**keyword** | **String** |  | 
+**messageid** | **String** |  | 
+**modified** | **String** |  | 
+**schedule** | **String** |  | 
+**status** | **String** |  | 
+**sender** | **String** |  | 
+**tag** | **String** |  | 
+
+

data/docs/MessagesApi.md

@@ -0,0 +1,278 @@
+# SwaggerClient::MessagesApi
+
+All URIs are relative to *https://api.thesmsworks.co.uk/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_scheduled_job**](MessagesApi.md#cancel_scheduled_job) | **DELETE** /messages/schedule/{messageid} | 
+[**get_message_by_id**](MessagesApi.md#get_message_by_id) | **GET** /messages/{messageid} | 
+[**get_messages**](MessagesApi.md#get_messages) | **POST** /messages | 
+[**schedule_message**](MessagesApi.md#schedule_message) | **POST** /message/schedule | 
+[**send_message**](MessagesApi.md#send_message) | **POST** /message/send | 
+
+
+# **cancel_scheduled_job**
+> CancelledMessageResponse cancel_scheduled_job(messageid)
+
+
+
+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::MessagesApi.new
+
+messageid = "messageid_example" # String | The ID of the message you would like returned
+
+
+begin
+  result = api_instance.cancel_scheduled_job(messageid)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling MessagesApi->cancel_scheduled_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **messageid** | **String**| The ID of the message 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_message_by_id**
+> MessageResponse get_message_by_id(messageid)
+
+
+
+Retrieve a logged message by the message 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::MessagesApi.new
+
+messageid = "messageid_example" # String | The ID of the message you would like returned
+
+
+begin
+  result = api_instance.get_message_by_id(messageid)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling MessagesApi->get_message_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **messageid** | **String**| The ID of the message you would like returned | 
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+
+# **get_messages**
+> MessagesResponse get_messages(query)
+
+
+
+Get messages matching your search criteria
+
+### 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::MessagesApi.new
+
+query = SwaggerClient::Query.new # Query | 
+
+
+begin
+  result = api_instance.get_messages(query)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling MessagesApi->get_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | [**Query**](Query.md)|  | 
+
+### Return type
+
+[**MessagesResponse**](MessagesResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+
+# **schedule_message**
+> ScheduledMessageResponse schedule_message(sms_message)
+
+
+
+Schedules an SMS message 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::MessagesApi.new
+
+sms_message = SwaggerClient::Message.new # Message | Message properties
+
+
+begin
+  result = api_instance.schedule_message(sms_message)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling MessagesApi->schedule_message: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sms_message** | [**Message**](Message.md)| Message properties | 
+
+### Return type
+
+[**ScheduledMessageResponse**](ScheduledMessageResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+
+# **send_message**
+> SendMessageResponse send_message(sms_message)
+
+
+
+Sends an 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::MessagesApi.new
+
+sms_message = SwaggerClient::Message.new # Message | Message properties
+
+
+begin
+  result = api_instance.send_message(sms_message)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling MessagesApi->send_message: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sms_message** | [**Message**](Message.md)| Message properties | 
+
+### Return type
+
+[**SendMessageResponse**](SendMessageResponse.md)
+
+### Authorization
+
+[JWT](../README.md#JWT)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+

data/docs/MessagesResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::MessagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**MessagesResponseMessages**](MessagesResponseMessages.md) |  | [optional] 
+
+

data/docs/MessagesResponseMessages.md

@@ -0,0 +1,8 @@
+# SwaggerClient::MessagesResponseMessages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schema** | [**MessageResponse**](MessageResponse.md) |  | [optional] 
+
+

data/docs/Query.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Query
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The status of the messages you would like returned (either 'SENT', 'DELIVERED', 'EXPIRED', 'DELETED', 'UNDELIVERABLE', 'ACCEPTED', 'UNKNOWN', 'REJECTED') | [optional] 
+**destination** | **String** | The phone number of the recipient | [optional] 
+**sender** | **String** | The sender of the message (this can be the configured sender name for an outbound message or the senders phone number for an inbound message). | [optional] 
+**keyword** | **String** | The keyword used in the inbound message | [optional] 
+**from** | **String** | The date-time from which you would like matching messages | [optional] 
+**to** | **String** | The date-time to which you would like matching messages | [optional] 
+
+

data/docs/ScheduledBatchResponse.md

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

data/docs/ScheduledMessageResponse.md

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

data/docs/SendMessageResponse.md

@@ -0,0 +1,10 @@
+# SwaggerClient::SendMessageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messageid** | **String** |  | 
+**status** | **String** |  | 
+**credits** | **Integer** |  | 
+
+

data/docs/TokenResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::TokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** |  | 
+
+

data/docs/UtilsApi.md

@@ -0,0 +1,56 @@
+# SwaggerClient::UtilsApi
+
+All URIs are relative to *https://api.thesmsworks.co.uk/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**hello**](UtilsApi.md#hello) | **GET** /utils/hello | 
+
+
+# **hello**
+> HelloWorldResponse hello(opts)
+
+
+
+Returns 'Hello' to the caller
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::UtilsApi.new
+
+opts = { 
+  name: "name_example" # String | The name of the person to whom to say hello
+}
+
+begin
+  result = api_instance.hello(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling UtilsApi->hello: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The name of the person to whom to say hello | [optional] 
+
+### Return type
+
+[**HelloWorldResponse**](HelloWorldResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json;charset=UTF-8
+
+
+