Documentation update and migration to openapi-codegen

telstra · Jun 20, 2018 · 8b8f3c3 · 8b8f3c3
1 parent 7bfc015
commit 8b8f3c3
Show file tree

Hide file tree

Showing 33 changed files with 455 additions and 336 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 
 - API version: 2.2.6
-- Package version: 1.0.4
+- Package version: 1.0.4.1
 
 ## Requirements.
 
@@ -43,11 +43,12 @@ import time
 import Telstra_Messaging
 from Telstra_Messaging.rest import ApiException
 from pprint import pprint
+
 # create an instance of the API class
-api_instance = Telstra_Messaging.AuthenticationApi()
+api_instance = Telstra_Messaging.AuthenticationApi(Telstra_Messaging.ApiClient(configuration))
 client_id = 'client_id_example' # str | 
 client_secret = 'client_secret_example' # str | 
-grant_type = 'client_credentials' # str |  (default to client_credentials)
+grant_type = 'client_credentials' # str |  (default to 'client_credentials')
 
 try:
     # Generate OAuth2 token
@@ -67,6 +68,7 @@ Class | Method | HTTP request | Description
 *AuthenticationApi* | [**auth_token**](docs/AuthenticationApi.md#auth_token) | **POST** /oauth/token | Generate OAuth2 token
 *MessagingApi* | [**get_mms_status**](docs/MessagingApi.md#get_mms_status) | **GET** /messages/mms/{messageid}/status | Get MMS Status
 *MessagingApi* | [**get_sms_status**](docs/MessagingApi.md#get_sms_status) | **GET** /messages/sms/{messageId}/status | Get SMS Status
+*MessagingApi* | [**retrieve_mms_responses**](docs/MessagingApi.md#retrieve_mms_responses) | **GET** /messages/mms | Retrieve MMS Responses
 *MessagingApi* | [**retrieve_sms_responses**](docs/MessagingApi.md#retrieve_sms_responses) | **GET** /messages/sms | Retrieve SMS Responses
 *MessagingApi* | [**send_mms**](docs/MessagingApi.md#send_mms) | **POST** /messages/mms | Send MMS
 *MessagingApi* | [**send_sms**](docs/MessagingApi.md#send_sms) | **POST** /messages/sms | Send SMS

diff --git a/Telstra_Messaging/__init__.py b/Telstra_Messaging/__init__.py
diff --git a/Telstra_Messaging/api/authentication_api.py b/Telstra_Messaging/api/authentication_api.py
diff --git a/Telstra_Messaging/api/messaging_api.py b/Telstra_Messaging/api/messaging_api.py
diff --git a/Telstra_Messaging/api/provisioning_api.py b/Telstra_Messaging/api/provisioning_api.py
diff --git a/Telstra_Messaging/api_client.py b/Telstra_Messaging/api_client.py
diff --git a/Telstra_Messaging/configuration.py b/Telstra_Messaging/configuration.py
diff --git a/Telstra_Messaging/models/__init__.py b/Telstra_Messaging/models/__init__.py
diff --git a/Telstra_Messaging/models/delete_number_request.py b/Telstra_Messaging/models/delete_number_request.py
diff --git a/Telstra_Messaging/models/get_subscription_response.py b/Telstra_Messaging/models/get_subscription_response.py
diff --git a/Telstra_Messaging/models/inbound_poll_response.py b/Telstra_Messaging/models/inbound_poll_response.py
diff --git a/Telstra_Messaging/models/message.py b/Telstra_Messaging/models/message.py
diff --git a/Telstra_Messaging/models/message_sent_response.py b/Telstra_Messaging/models/message_sent_response.py
diff --git a/Telstra_Messaging/models/mms_content.py b/Telstra_Messaging/models/mms_content.py
diff --git a/Telstra_Messaging/models/o_auth_response.py b/Telstra_Messaging/models/o_auth_response.py
diff --git a/Telstra_Messaging/models/outbound_poll_response.py b/Telstra_Messaging/models/outbound_poll_response.py
diff --git a/Telstra_Messaging/models/provision_number_request.py b/Telstra_Messaging/models/provision_number_request.py
diff --git a/Telstra_Messaging/models/provision_number_response.py b/Telstra_Messaging/models/provision_number_response.py
diff --git a/Telstra_Messaging/models/send_mms_request.py b/Telstra_Messaging/models/send_mms_request.py
diff --git a/Telstra_Messaging/models/send_sms_request.py b/Telstra_Messaging/models/send_sms_request.py
diff --git a/Telstra_Messaging/models/status.py b/Telstra_Messaging/models/status.py
diff --git a/Telstra_Messaging/rest.py b/Telstra_Messaging/rest.py
diff --git a/docs/AuthenticationApi.md b/docs/AuthenticationApi.md
@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 Generate OAuth2 token
 
-To generate an OAuth2 Authentication token, pass through your `Client key` and `Client secret` that you received when you registered for the &quot;API Free Trial&quot; 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&amp;client_id=$CLIENT_KEY&amp;client_secret=CLIENT_SECRET&amp;scope=NSMS' \\   'https://tapi.telstra.com/v2/oauth/token' </code></pre> 
+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. 
 
 ### Example
 ```python
@@ -26,7 +26,7 @@ from pprint import pprint
 api_instance = Telstra_Messaging.AuthenticationApi()
 client_id = 'client_id_example' # str | 
 client_secret = 'client_secret_example' # str | 
-grant_type = 'client_credentials' # str |  (default to client_credentials)
+grant_type = 'client_credentials' # str |  (default to 'client_credentials')
 
 try:
     # Generate OAuth2 token
@@ -42,7 +42,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **client_id** | **str**|  | 
  **client_secret** | **str**|  | 
- **grant_type** | **str**|  | [default to client_credentials]
+ **grant_type** | **str**|  | [default to &#39;client_credentials&#39;]
 
 ### Return type
 

diff --git a/docs/InboundPollResponse.md b/docs/InboundPollResponse.md
@@ -4,8 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **status** | **str** | message status | [optional] 
-**destination_address** | **str** | The phone number (recipient) that the message was sent to(in E.164 format). | [optional] 
-**sender_address** | **str** | The phone number (sender) that the message was sent from (in E.164 format). | [optional] 
+**destination_address** | **str** | The phone number (recipient) that the message was sent to (in E.164 format).  | [optional] 
+**sender_address** | **str** | The phone number (sender) that the message was sent from (in E.164 format).  | [optional] 
 **message** | **str** | Text of the message that was sent | [optional] 
 **message_id** | **str** | Message Id | [optional] 
 **sent_timestamp** | **str** | The date and time when the message was sent by recipient. | [optional] 

diff --git a/docs/MMSContent.md b/docs/MMSContent.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **str** | 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** | **str** | 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\&quot; | 
 **filename** | **str** | The file name to be associated with the content. Some devices will display this file name with a placeholder for the content. | 
 **payload** | **str** |  |