Skip to content

Commit 2311903

Browse files
Documentation update and migration to openapi-codegen
1 parent fc9ce3f commit 2311903

29 files changed

+301
-240
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
TelstraMessaging - JavaScript client for Telstra_Messaging
44

55
- API version: 2.2.6
6-
- Package version: 1.0.4
6+
- Package version: 1.0.4.1
77

88
## Installation
99

@@ -92,13 +92,9 @@ Please follow the [installation](#installation) instruction and execute the foll
9292
var TelstraMessaging = require('Telstra_Messaging');
9393

9494
var api = new TelstraMessaging.AuthenticationApi()
95-
9695
var clientId = "clientId_example"; // {String}
97-
9896
var clientSecret = "clientSecret_example"; // {String}
99-
100-
var grantType = "client_credentials"; // {String}
101-
97+
var grantType = "'client_credentials'"; // {String}
10298

10399
var callback = function(error, data, response) {
104100
if (error) {
@@ -120,6 +116,7 @@ Class | Method | HTTP request | Description
120116
*TelstraMessaging.AuthenticationApi* | [**authToken**](docs/AuthenticationApi.md#authToken) | **POST** /oauth/token | Generate OAuth2 token
121117
*TelstraMessaging.MessagingApi* | [**getMMSStatus**](docs/MessagingApi.md#getMMSStatus) | **GET** /messages/mms/{messageid}/status | Get MMS Status
122118
*TelstraMessaging.MessagingApi* | [**getSMSStatus**](docs/MessagingApi.md#getSMSStatus) | **GET** /messages/sms/{messageId}/status | Get SMS Status
119+
*TelstraMessaging.MessagingApi* | [**retrieveMMSResponses**](docs/MessagingApi.md#retrieveMMSResponses) | **GET** /messages/mms | Retrieve MMS Responses
123120
*TelstraMessaging.MessagingApi* | [**retrieveSMSResponses**](docs/MessagingApi.md#retrieveSMSResponses) | **GET** /messages/sms | Retrieve SMS Responses
124121
*TelstraMessaging.MessagingApi* | [**sendMMS**](docs/MessagingApi.md#sendMMS) | **POST** /messages/mms | Send MMS
125122
*TelstraMessaging.MessagingApi* | [**sendSMS**](docs/MessagingApi.md#sendSMS) | **POST** /messages/sms | Send SMS

docs/AuthenticationApi.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,16 @@ Method | HTTP request | Description
1313
1414
Generate OAuth2 token
1515

16-
To generate an OAuth2 Authentication token, pass through your `Client key` and `Client secret` that you received when you registered for the "API Free Trial" Product. The grant_type should be left as `client_credentials` and the scope as `NSMS`. The token will expire in one hour. <pre><code class=\"language-sh\"> #!/bin/bash # Obtain these keys from the Telstra Developer Portal CLIENT_KEY=\"your client key\" CLIENT_SECRET=\"your client secret\" curl -X POST -H 'Content-Type: application/x-www-form-urlencoded' \\ -d 'grant_type=client_credentials&client_id=$CLIENT_KEY&client_secret=CLIENT_SECRET&scope=NSMS' \\ 'https://tapi.telstra.com/v2/oauth/token' </code></pre>
16+
To generate an OAuth2 Authentication token, pass through your `Client key` and `Client secret` that you received when you registered for the **API Free Trial** Product. The grant_type should be left as `client_credentials` and the scope as `NSMS`. The token will expire in one hour.
1717

1818
### Example
1919
```javascript
2020
var TelstraMessaging = require('Telstra_Messaging');
2121

2222
var apiInstance = new TelstraMessaging.AuthenticationApi();
23-
2423
var clientId = "clientId_example"; // String |
25-
2624
var clientSecret = "clientSecret_example"; // String |
27-
28-
var grantType = "client_credentials"; // String |
29-
30-
25+
var grantType = "'client_credentials'"; // String |
3126
var callback = function(error, data, response) {
3227
if (error) {
3328
console.error(error);
@@ -44,7 +39,7 @@ Name | Type | Description | Notes
4439
------------- | ------------- | ------------- | -------------
4540
**clientId** | **String**| |
4641
**clientSecret** | **String**| |
47-
**grantType** | **String**| | [default to client_credentials]
42+
**grantType** | **String**| | [default to 'client_credentials']
4843

4944
### Return type
5045

docs/InboundPollResponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**status** | **String** | message status | [optional]
7-
**destinationAddress** | **String** | The phone number (recipient) that the message was sent to(in E.164 format). | [optional]
8-
**senderAddress** | **String** | The phone number (sender) that the message was sent from (in E.164 format). | [optional]
7+
**destinationAddress** | **String** | The phone number (recipient) that the message was sent to (in E.164 format). | [optional]
8+
**senderAddress** | **String** | The phone number (sender) that the message was sent from (in E.164 format). | [optional]
99
**message** | **String** | Text of the message that was sent | [optional]
1010
**messageId** | **String** | Message Id | [optional]
1111
**sentTimestamp** | **String** | The date and time when the message was sent by recipient. | [optional]

docs/MMSContent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**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 |
6+
**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\" |
77
**filename** | **String** | The file name to be associated with the content. Some devices will display this file name with a placeholder for the content. |
88
**payload** | **String** | |
99

0 commit comments

Comments
 (0)