Skip to content

Commit 1ef5802

Browse files
Documentation update
1 parent 2311903 commit 1ef5802

23 files changed

+100
-126
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
TelstraMessaging - JavaScript client for Telstra_Messaging
44

5-
- API version: 2.2.6
6-
- Package version: 1.0.4.1
5+
- API version: 2.2.7
6+
- Package version: 1.0.5
77

88
## Installation
99

docs/MessageSentResponse.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**messages** | [**[Message]**](Message.md) | An array of messages. |
7+
**country** | **String** | An array of the countries to which the destination MSISDNs belong. | [optional]
78
**messageType** | **String** | This returns whether the message sent was a SMS or MMS. |
8-
**numberSegments** | **Number** | For SMS messages only, the value indicates the number of 160 character message segments sent. |
9-
**numberNationalDestinations** | **Number** | This returns the number of domestic Australian messages sent. | [optional]
10-
**numberInternationalDestinations** | **Number** | This returns the number of international messages sent | [optional]
9+
**numberSegments** | **Number** | For SMS messages only, the value indicates the number of 160 character message segments sent. |
1110

1211

docs/MessagingApi.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -209,8 +209,7 @@ var auth = defaultClient.authentications['auth'];
209209
auth.accessToken = 'YOUR ACCESS TOKEN';
210210

211211
var apiInstance = new TelstraMessaging.MessagingApi();
212-
var sendMmsRequest = new TelstraMessaging.SendMmsRequest(); // SendMmsRequest | A JSON or XML payload containing the recipient's phone number and MMS message.
213-
The recipient number should be in the format '04xxxxxxxx' where x is a digit.
212+
var sendMmsRequest = new TelstraMessaging.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.
214213

215214
var callback = function(error, data, response) {
216215
if (error) {
@@ -226,8 +225,7 @@ apiInstance.sendMMS(sendMmsRequest, callback);
226225

227226
Name | Type | Description | Notes
228227
------------- | ------------- | ------------- | -------------
229-
**sendMmsRequest** | [**SendMmsRequest**](SendMmsRequest.md)| A JSON or XML payload containing the recipient's phone number and MMS message.
230-
The recipient number should be in the format '04xxxxxxxx' where x is a digit.
228+
**sendMmsRequest** | [**SendMmsRequest**](SendMmsRequest.md)| 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.
231229
|
232230

233231
### Return type
@@ -260,8 +258,7 @@ var auth = defaultClient.authentications['auth'];
260258
auth.accessToken = 'YOUR ACCESS TOKEN';
261259

262260
var apiInstance = new TelstraMessaging.MessagingApi();
263-
var sendSMSRequest = new TelstraMessaging.SendSMSRequest(); // SendSMSRequest | A JSON or XML payload containing the recipient's phone number and text message.
264-
This number can be in international format if preceeded by a ‘+’ or in national format ('04xxxxxxxx') where x is a digit.
261+
var sendSMSRequest = new TelstraMessaging.SendSMSRequest(); // SendSMSRequest | A JSON or XML payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit.
265262

266263
var callback = function(error, data, response) {
267264
if (error) {
@@ -277,8 +274,7 @@ apiInstance.sendSMS(sendSMSRequest, callback);
277274

278275
Name | Type | Description | Notes
279276
------------- | ------------- | ------------- | -------------
280-
**sendSMSRequest** | [**SendSMSRequest**](SendSMSRequest.md)| A JSON or XML payload containing the recipient's phone number and text message.
281-
This number can be in international format if preceeded by a ‘+’ or in national format ('04xxxxxxxx') where x is a digit.
277+
**sendSMSRequest** | [**SendSMSRequest**](SendSMSRequest.md)| A JSON or XML payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit.
282278
|
283279

284280
### Return type

docs/ProvisionNumberRequest.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,5 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**activeDays** | **Number** | The number of days before for which this number is provisioned. Usually this will be same as the plan you buy. | [optional]
77
**notifyURL** | **String** | A notification URL that will be POSTed to whenever a new message (e.g. a reply to a message sent) arrives at this destination address. If this is not provided then you can use the Get /sms or /mms API to poll for reply messages. *Please note that the notification URLs and the Get /sms or /mms call are exclusive. If a notification URL has been set then the GET call will not provide any useful information.* | [optional]
8-
**callbackData** | **String** | A JSON that will be sent as the body in the POST to the notifyURL. This can be any meaningful data relevant to your application. | [optional]
98

109

package.json

Lines changed: 7 additions & 7 deletions
Large diffs are not rendered by default.

src/ApiClient.js

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

src/api/AuthenticationApi.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/api/MessagingApi.js

Lines changed: 6 additions & 8 deletions
Large diffs are not rendered by default.

src/api/ProvisioningApi.js

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

src/index.js

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/DeleteNumberRequest.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/GetSubscriptionResponse.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/InboundPollResponse.js

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

src/model/MMSContent.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/Message.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/MessageSentResponse.js

Lines changed: 15 additions & 24 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/OAuthResponse.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/OutboundPollResponse.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/ProvisionNumberRequest.js

Lines changed: 4 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/ProvisionNumberResponse.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/SendMmsRequest.js

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

src/model/SendSMSRequest.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/model/Status.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)