Documentation update and migration to openapi-codegen

Author: developersteve

README.md

@@ -1,35 +1,45 @@
 # TelstraMessaging
 
+Telstra Messaging API
+- API version: 2.2.6
+  - Build date: 2018-06-20T14:25:51.755551+10:00[Australia/Melbourne]
+
+
+
+
+
 ## Requirements
 
-Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
+Building the API client library requires:
+1. Java 1.7+
+2. Maven/Gradle
 
 ## Installation
 
 To install the API client library to your local Maven repository, simply execute:
 
 ```shell
-mvn install
+mvn clean install
 ```
 
 To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
 
 ```shell
-mvn deploy
+mvn clean deploy
 ```
 
-Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
+Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
 
 ### Maven users
 
 Add this dependency to your project's POM:
 
 ```xml
 <dependency>
-    <groupId>Telstra</groupId>
-    <artifactId>TelstraMessaging</artifactId>
-    <version>1.0.0</version>
-    <scope>compile</scope>
+  <groupId>Telstra</groupId>
+  <artifactId>TelstraMessaging</artifactId>
+  <version>1.0.0</version>
+  <scope>compile</scope>
 </dependency>
 ```
 
@@ -45,12 +55,13 @@ compile "Telstra:TelstraMessaging:1.0.0"
 
 At first generate the JAR by executing:
 
-    mvn package
+```shell
+```
 
 Then manually install the following JARs:
 
-* target/TelstraMessaging-1.0.0.jar
-* target/lib/*.jar
+* `target/TelstraMessaging-1.0.0.jar`
+* `target/lib/*.jar`
 
 ## Getting Started
 
@@ -71,9 +82,9 @@ public class AuthenticationApiExample {
     public static void main(String[] args) {
 
         AuthenticationApi apiInstance = new AuthenticationApi();
-        String clientId = "clientId_example"; // String | 
-        String clientSecret = "clientSecret_example"; // String | 
-        String grantType = "client_credentials"; // String | 
+        String clientId = "null"; // String | 
+        String clientSecret = "null"; // String | 
+        String grantType = "\"client_credentials\""; // String | 
         try {
             OAuthResponse result = apiInstance.authToken(clientId, clientSecret, grantType);
             System.out.println(result);
@@ -92,9 +103,10 @@ All URIs are relative to *https://tapi.telstra.com/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*AuthenticationApi* | [**authToken**](docs/AuthenticationApi.md#authToken) | **POST** /oauth/token | Generate authentication token
+*AuthenticationApi* | [**authToken**](docs/AuthenticationApi.md#authToken) | **POST** /oauth/token | Generate OAuth2 token
 *MessagingApi* | [**getMMSStatus**](docs/MessagingApi.md#getMMSStatus) | **GET** /messages/mms/{messageid}/status | Get MMS Status
 *MessagingApi* | [**getSMSStatus**](docs/MessagingApi.md#getSMSStatus) | **GET** /messages/sms/{messageId}/status | Get SMS Status
+*MessagingApi* | [**retrieveMMSResponses**](docs/MessagingApi.md#retrieveMMSResponses) | **GET** /messages/mms | Retrieve MMS Responses
 *MessagingApi* | [**retrieveSMSResponses**](docs/MessagingApi.md#retrieveSMSResponses) | **GET** /messages/sms | Retrieve SMS Responses
 *MessagingApi* | [**sendMMS**](docs/MessagingApi.md#sendMMS) | **POST** /messages/mms | Send MMS
 *MessagingApi* | [**sendSMS**](docs/MessagingApi.md#sendSMS) | **POST** /messages/sms | Send SMS
@@ -106,15 +118,11 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [DeleteNumberRequest](docs/DeleteNumberRequest.md)
- - [ErrorError](docs/ErrorError.md)
- - [ErrorErrorError](docs/ErrorErrorError.md)
  - [GetSubscriptionResponse](docs/GetSubscriptionResponse.md)
  - [InboundPollResponse](docs/InboundPollResponse.md)
  - [MMSContent](docs/MMSContent.md)
  - [Message](docs/Message.md)
  - [MessageSentResponse](docs/MessageSentResponse.md)
- - [MessageType](docs/MessageType.md)
- - [OAuthRequest](docs/OAuthRequest.md)
  - [OAuthResponse](docs/OAuthResponse.md)
  - [OutboundPollResponse](docs/OutboundPollResponse.md)
  - [ProvisionNumberRequest](docs/ProvisionNumberRequest.md)
@@ -124,14 +132,14 @@ Class | Method | HTTP request | Description
  - [Status](docs/Status.md)
 
 
-## Documentation for Authorization
+## Documentation for Authorisation
 
 Authentication schemes defined for the API:
 ### auth
 
 - **Type**: OAuth
 - **Flow**: application
-- **Authorization URL**: 
+- **Authorisation URL**: 
 - **Scopes**: 
   - NSMS: NSMS
 

build.gradle

@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
 }
 
 dependencies {
-    compile 'io.swagger:swagger-annotations:1.5.15'
+    compile 'io.swagger:swagger-annotations:1.5.17'
     compile 'com.squareup.okhttp:okhttp:2.7.5'
     compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
     compile 'com.google.code.gson:gson:2.8.1'
-    compile 'joda-time:joda-time:2.9.9'
+    compile 'io.gsonfire:gson-fire:1.8.0'
+    compile 'org.threeten:threetenbp:1.3.5'
     testCompile 'junit:junit:4.12'
 }

build.sbt

@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
     publishArtifact in (Compile, packageDoc) := false,
     resolvers += Resolver.mavenLocal,
     libraryDependencies ++= Seq(
-      "io.swagger" % "swagger-annotations" % "1.5.15",
+      "io.swagger" % "swagger-annotations" % "1.5.17",
       "com.squareup.okhttp" % "okhttp" % "2.7.5",
       "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
       "com.google.code.gson" % "gson" % "2.8.1",
-      "joda-time" % "joda-time" % "2.9.9" % "compile",
+      "org.threeten" % "threetenbp" % "1.3.5" % "compile",
+      "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
       "junit" % "junit" % "4.12" % "test",
       "com.novocode" % "junit-interface" % "0.10" % "test"
     )

docs/AuthenticationApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://tapi.telstra.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**authToken**](AuthenticationApi.md#authToken) | **POST** /oauth/token | Generate authentication token
+[**authToken**](AuthenticationApi.md#authToken) | **POST** /oauth/token | Generate OAuth2 token
 
 
 <a name="authToken"></a>
 # **authToken**
 > OAuthResponse authToken(clientId, clientSecret, grantType)
 
-Generate authentication token
+Generate OAuth2 token
 
-Generate authentication token
+To generate an OAuth2 Authentication token, pass through your &#x60;Client key&#x60; and &#x60;Client secret&#x60; that you received when you registered for the **API Free Trial** Product. The grant_type should be left as &#x60;client_credentials&#x60; and the scope as &#x60;NSMS&#x60;. The token will expire in one hour. 
 
 ### Example
 ```java
@@ -23,9 +23,9 @@ Generate authentication token
 
 
 AuthenticationApi apiInstance = new AuthenticationApi();
-String clientId = "clientId_example"; // String | 
-String clientSecret = "clientSecret_example"; // String | 
-String grantType = "client_credentials"; // String | 
+String clientId = "null"; // String | 
+String clientSecret = "null"; // String | 
+String grantType = "\"client_credentials\""; // String | 
 try {
     OAuthResponse result = apiInstance.authToken(clientId, clientSecret, grantType);
     System.out.println(result);
@@ -39,9 +39,9 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **clientId** | **String**|  |
- **clientSecret** | **String**|  |
- **grantType** | **String**|  | [default to client_credentials]
+ **clientId** | **String**|  | [default to null]
+ **clientSecret** | **String**|  | [default to null]
+ **grantType** | **String**|  | [default to &quot;client_credentials&quot;]
 
 ### Return type
 

docs/InboundPollResponse.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **status** | **String** | message status |  [optional]
-**destinationAddress** | **String** | The phone number (recipient) that the message was sent to(in E.164 format). |  [optional]
-**senderAddress** | **String** | The phone number (sender) that the message was sent from (in E.164 format). |  [optional]
+**destinationAddress** | **String** | The phone number (recipient) that the message was sent to (in E.164 format).  |  [optional]
+**senderAddress** | **String** | The phone number (sender) that the message was sent from (in E.164 format).  |  [optional]
 **message** | **String** | Text of the message that was sent |  [optional]
 **messageId** | **String** | Message Id |  [optional]
 **sentTimestamp** | **String** | The date and time when the message was sent by recipient. |  [optional]

docs/MMSContent.md

@@ -4,7 +4,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The following types are supported audio/amr  audio/aac  audio/mp3  audio/mpeg3  audio/mpeg  audio/mpg  audio/wav  audio/3gpp  audio/mp4  image/gif  image/jpeg  image/jpg  image/png  image/bmp  video/mpeg4  video/mp4  video/mpeg  video/3gpp  video/3gp  video/h263  text/plain  text/x-vCard  text/x-vCalendar | 
+**type** | **String** | The following types are supported audio/amr audio/aac audio/mp3 audio/mpeg3 audio/mpeg audio/mpg audio/wav audio/3gpp audio/mp4 image/gif image/jpeg image/jpg image/png image/bmp video/mpeg4 video/mp4 video/mpeg video/3gpp video/3gp video/h263 text/plain text/x-vCard text/x-vCalendar\" | 
 **filename** | **String** | The file name to be associated with the content. Some devices will display this file name with a placeholder for the content. | 
 **payload** | **String** |  | 
 

docs/Message.md

@@ -4,10 +4,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**to** | **String** |  | 
-**deliveryStatus** | **String** |  | 
-**messageId** | **String** |  | 
-**messageStatusURL** | **String** |  |  [optional]
+**to** | **String** | Just a copy of the number the message is sent to. | 
+**deliveryStatus** | **String** | Gives an indication if the message has been accepted for delivery. The description field contains information on why a message may have been rejected. | 
+**messageId** | **String** | For an accepted message, ths will be a unique reference that can be used to check the messages status. Please refer to the Delivery Notification section. Note that `messageId` will be different for each number that the message was sent to. | 
+**messageStatusURL** | **String** | For an accepted message, ths will be the URL that can be used to check the messages status. Please refer to the Delivery Notification section. |  [optional]
 
 
 

docs/MessageSentResponse.md

@@ -4,11 +4,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**messages** | [**List<Message>**](Message.md) |  | 
-**messageType** | **String** |  | 
-**numberSegments** | **Integer** |  | 
-**numberNationalDestinations** | **Integer** |  |  [optional]
-**numberInternationalDestinations** | **Integer** |  |  [optional]
+**messages** | [**List<Message>**](Message.md) | An array of messages. | 
+**messageType** | **String** | This returns whether the message sent was a SMS or MMS. | 
+**numberSegments** | **Integer** | For SMS messages only, the value indicates the number of 160 character message segments sent. | 
+**numberNationalDestinations** | **Integer** | This returns the number of domestic Australian messages sent. |  [optional]
+**numberInternationalDestinations** | **Integer** | This returns the number of international messages sent |  [optional]