Skip to content

Commit 7a59ae1

Browse files
developerstevedevelopersteve
committed
1.0.2 SDK release
1 parent 6290cc9 commit 7a59ae1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1525
-313
lines changed

‎README.md‎

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ To deploy it to a remote Maven repository instead, configure the settings of the
1818
mvn deploy
1919
```
2020

21-
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
2221

2322
### Maven users
2423

@@ -48,7 +47,6 @@ At first generate the JAR by executing:
4847

4948
Then manually install the following JARs:
5049

51-
* target/TelstraMessaging-1.0.0.jar
5250
* target/lib/*.jar
5351

5452
## Getting Started
@@ -90,7 +88,6 @@ public class AuthenticationApiExample {
9088
All URIs are relative to *https://tapi.telstra.com/v2*
9189

9290
Class | Method | HTTP request | Description
93-
------------ | ------------- | ------------- | -------------
9491
*AuthenticationApi* | [**authToken**](docs/AuthenticationApi.md#authToken) | **POST** /oauth/token | Generate authentication token
9592
*MessagingApi* | [**getMMSStatus**](docs/MessagingApi.md#getMMSStatus) | **GET** /messages/mms/{messageid}/status | Get MMS Status
9693
*MessagingApi* | [**getSMSStatus**](docs/MessagingApi.md#getSMSStatus) | **GET** /messages/sms/{messageId}/status | Get SMS Status
@@ -104,33 +101,13 @@ Class | Method | HTTP request | Description
104101

105102
## Documentation for Models
106103

107-
- [ErrorError](docs/ErrorError.md)
108-
- [ErrorErrorError](docs/ErrorErrorError.md)
109-
- [InboundPollResponse](docs/InboundPollResponse.md)
110-
- [MMSContent](docs/MMSContent.md)
111-
- [Message](docs/Message.md)
112-
- [MessageSentResponse](docs/MessageSentResponse.md)
113-
- [MessageType](docs/MessageType.md)
114-
- [OAuthRequest](docs/OAuthRequest.md)
115-
- [OAuthResponse](docs/OAuthResponse.md)
116-
- [OutboundPollResponse](docs/OutboundPollResponse.md)
117-
- [ProvisionNumberRequest](docs/ProvisionNumberRequest.md)
118-
- [ProvisionNumberResponse](docs/ProvisionNumberResponse.md)
119-
- [SendMmsRequest](docs/SendMmsRequest.md)
120-
- [SendSMSRequest](docs/SendSMSRequest.md)
121-
- [Status](docs/Status.md)
122-
123-
124-
## Documentation for Authorization
104+
105+
106+
## Documentation for Authorisation
125107

126108
Authentication schemes defined for the API:
127109
### auth
128110

129-
- **Type**: OAuth
130-
- **Flow**: application
131-
- **Authorization URL**:
132-
- **Scopes**:
133-
- NSMS: NSMS
134111

135112

136113
## Recommendation

‎docs/AuthApi.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# AuthApi
2+
3+
All URIs are relative to *https://tapi.telstra.com/v2*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**oauthTokenPost**](AuthApi.md#oauthTokenPost) | **POST** /oauth/token | AuthGeneratetokenPost
8+
9+
10+
<a name="oauthTokenPost"></a>
11+
# **oauthTokenPost**
12+
> AuthgeneratetokenpostResponse oauthTokenPost(oAuthClientId, oAuthClientSecret)
13+
14+
AuthGeneratetokenPost
15+
16+
generate auth token
17+
18+
### Example
19+
```java
20+
// Import classes:
21+
//import com.telstra.ApiException;
22+
//import com.telstra.messaging.AuthApi;
23+
24+
25+
AuthApi apiInstance = new AuthApi();
26+
String oAuthClientId = "oAuthClientId_example"; // String |
27+
String oAuthClientSecret = "oAuthClientSecret_example"; // String |
28+
try {
29+
AuthgeneratetokenpostResponse result = apiInstance.oauthTokenPost(oAuthClientId, oAuthClientSecret);
30+
System.out.println(result);
31+
} catch (ApiException e) {
32+
System.err.println("Exception when calling AuthApi#oauthTokenPost");
33+
e.printStackTrace();
34+
}
35+
```
36+
37+
### Parameters
38+
39+
Name | Type | Description | Notes
40+
------------- | ------------- | ------------- | -------------
41+
**oAuthClientId** | **String**| |
42+
**oAuthClientSecret** | **String**| |
43+
44+
### Return type
45+
46+
[**AuthgeneratetokenpostResponse**](AuthgeneratetokenpostResponse.md)
47+
48+
### Authorization
49+
50+
No authorization required
51+
52+
### HTTP request headers
53+
54+
- **Content-Type**: application/x-www-form-urlencoded
55+
- **Accept**: application/json
56+

‎docs/AuthgeneratetokenpostResponse.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
# AuthgeneratetokenpostResponse
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**accessToken** | **String** | | [optional]
8+
**expiresIn** | **Integer** | | [optional]
9+
**refreshToken** | **String** | | [optional]
10+
**tokenType** | **String** | | [optional]
11+
12+
13+

‎docs/DeleteNumberRequest.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
# DeleteNumberRequest
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**emptyArr** | **Integer** | Empty Arr | [optional]
8+
9+
10+

‎docs/ErrorErrorError62.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# ErrorErrorError62
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**status** | **String** | A short error code |
8+
**message** | **String** | Message describing the error. | [optional]
9+
10+
11+

‎docs/ErrorErrorErrorError.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# ErrorErrorErrorError
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**status** | **Integer** | The status code. | [optional]
8+
**message** | **String** | Message describing the error. | [optional]
9+
10+
11+

‎docs/GetSubscriptionResponse.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
# GetSubscriptionResponse
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**activeDays** | **String** | Number of active days | [optional]
8+
**notifyURL** | **String** | Notify url configured | [optional]
9+
**destinationAddress** | **String** | The mobile phone number that was allocated | [optional]
10+
11+
12+

‎docs/InboundPollResponse.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**to** | **String** | The phone number (recipient) that the message was sent to(in E.164 format). | [optional]
8-
**from** | **String** | The phone number (sender) that the message was sent from (in E.164 format). | [optional]
9-
**body** | **String** | Text body of the message that was sent | [optional]
10-
**receivedTimestamp** | **String** | The date and time when the message was recieved by recipient. | [optional]
11-
**moreMessages** | **Integer** | Indicates if there are more messages that can be polled from the server. 0&#x3D;No more messages available. Anything else indicates there are more messages on the server. | [optional]
12-
**messageId** | **String** | Optional message ID of the SMS you sent. Use this ID to view the message status or get responses. | [optional]
7+
**status** | **String** | message status | [optional]
8+
**destinationAddress** | **String** | The phone number (recipient) that the message was sent to(in E.164 format). | [optional]
9+
**senderAddress** | **String** | The phone number (sender) that the message was sent from (in E.164 format). | [optional]
10+
**message** | **String** | Text of the message that was sent | [optional]
11+
**messageId** | **String** | Message Id | [optional]
12+
**sentTimestamp** | **String** | The date and time when the message was sent by recipient. | [optional]
1313

1414

1515

‎docs/Message.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**to** | **String** | |
88
**deliveryStatus** | **String** | |
99
**messageId** | **String** | |
10-
**messageStatusURL** | **String** | |
10+
**messageStatusURL** | **String** | | [optional]
1111

1212

1313

‎docs/MessagingApi.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Method | HTTP request | Description
1313

1414
<a name="getMMSStatus"></a>
1515
# **getMMSStatus**
16-
> OutboundPollResponse getMMSStatus(messageid)
16+
> List&lt;OutboundPollResponse&gt; getMMSStatus(messageid)
1717
1818
Get MMS Status
1919

@@ -37,7 +37,7 @@ auth.setAccessToken("YOUR ACCESS TOKEN");
3737
MessagingApi apiInstance = new MessagingApi();
3838
String messageid = "messageid_example"; // String | Unique identifier of a message - it is the value returned from a previous POST call to https://api.telstra.com/v2/messages/mms
3939
try {
40-
OutboundPollResponse result = apiInstance.getMMSStatus(messageid);
40+
List<OutboundPollResponse> result = apiInstance.getMMSStatus(messageid);
4141
System.out.println(result);
4242
} catch (ApiException e) {
4343
System.err.println("Exception when calling MessagingApi#getMMSStatus");
@@ -53,7 +53,7 @@ Name | Type | Description | Notes
5353

5454
### Return type
5555

56-
[**OutboundPollResponse**](OutboundPollResponse.md)
56+
[**List&lt;OutboundPollResponse&gt;**](OutboundPollResponse.md)
5757

5858
### Authorization
5959

@@ -66,7 +66,7 @@ Name | Type | Description | Notes
6666

6767
<a name="getSMSStatus"></a>
6868
# **getSMSStatus**
69-
> OutboundPollResponse getSMSStatus(messageId)
69+
> List&lt;OutboundPollResponse&gt; getSMSStatus(messageId)
7070
7171
Get SMS Status
7272

@@ -90,7 +90,7 @@ auth.setAccessToken("YOUR ACCESS TOKEN");
9090
MessagingApi apiInstance = new MessagingApi();
9191
String messageId = "messageId_example"; // String | Unique identifier of a message - it is the value returned from a previous POST call to https://api.telstra.com/v2/messages/sms
9292
try {
93-
OutboundPollResponse result = apiInstance.getSMSStatus(messageId);
93+
List<OutboundPollResponse> result = apiInstance.getSMSStatus(messageId);
9494
System.out.println(result);
9595
} catch (ApiException e) {
9696
System.err.println("Exception when calling MessagingApi#getSMSStatus");
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
106106

107107
### Return type
108108

109-
[**OutboundPollResponse**](OutboundPollResponse.md)
109+
[**List&lt;OutboundPollResponse&gt;**](OutboundPollResponse.md)
110110

111111
### Authorization
112112

@@ -119,7 +119,7 @@ Name | Type | Description | Notes
119119

120120
<a name="retrieveSMSResponses"></a>
121121
# **retrieveSMSResponses**
122-
> List&lt;InboundPollResponse&gt; retrieveSMSResponses()
122+
> InboundPollResponse retrieveSMSResponses()
123123
124124
Retrieve SMS Responses
125125

@@ -142,7 +142,7 @@ auth.setAccessToken("YOUR ACCESS TOKEN");
142142

143143
MessagingApi apiInstance = new MessagingApi();
144144
try {
145-
List<InboundPollResponse> result = apiInstance.retrieveSMSResponses();
145+
InboundPollResponse result = apiInstance.retrieveSMSResponses();
146146
System.out.println(result);
147147
} catch (ApiException e) {
148148
System.err.println("Exception when calling MessagingApi#retrieveSMSResponses");
@@ -155,7 +155,7 @@ This endpoint does not need any parameter.
155155

156156
### Return type
157157

158-
[**List&lt;InboundPollResponse&gt;**](InboundPollResponse.md)
158+
[**InboundPollResponse**](InboundPollResponse.md)
159159

160160
### Authorization
161161

@@ -168,7 +168,7 @@ This endpoint does not need any parameter.
168168

169169
<a name="sendMMS"></a>
170170
# **sendMMS**
171-
> Object sendMMS(body)
171+
> MessageSentResponse sendMMS(body)
172172
173173
Send MMS
174174

@@ -192,7 +192,7 @@ auth.setAccessToken("YOUR ACCESS TOKEN");
192192
MessagingApi apiInstance = new MessagingApi();
193193
SendMmsRequest body = new SendMmsRequest(); // SendMmsRequest | A JSON or XML payload containing the recipient's phone number and MMS message.The recipient number should be in the format '04xxxxxxxx' where x is a digit
194194
try {
195-
Object result = apiInstance.sendMMS(body);
195+
MessageSentResponse result = apiInstance.sendMMS(body);
196196
System.out.println(result);
197197
} catch (ApiException e) {
198198
System.err.println("Exception when calling MessagingApi#sendMMS");
@@ -208,7 +208,7 @@ Name | Type | Description | Notes
208208

209209
### Return type
210210

211-
**Object**
211+
[**MessageSentResponse**](MessageSentResponse.md)
212212

213213
### Authorization
214214

0 commit comments

Comments
 (0)