Deploy

Author: DX-Bandwidth

MANIFEST.in

@@ -1,2 +1,2 @@
 include LICENSE
-include README.md
+include README.md

README.md

@@ -1,66 +1,102 @@
-# Getting Started with bandwidth
-
-Bandwidth's set of APIs
-
-## Install the Package
-
-The package is compatible with Python versions ```2 >=2.7.9``` and ```3 >=3.4```.
-Install the package from PyPi using the following pip command:
-
-```python
-pip install bandwidth-sdk==5.2.0
-```
-
-You can also view the package at:
-https://pypi.python.org/pypi/bandwidth-sdk
-
-## Initialize the API Client
-
-The following parameters are configurable for the API Client.
-
-| Parameter | Type | Description |
-|  --- | --- | --- |
-| `messaging_basic_auth_user_name` | `string` | The username to use with basic authentication |
-| `messaging_basic_auth_password` | `string` | The password to use with basic authentication |
-| `voice_basic_auth_user_name` | `string` | The username to use with basic authentication |
-| `voice_basic_auth_password` | `string` | The password to use with basic authentication |
-| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
-| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |
-| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 3** |
-| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 0** |
-
-The API client can be initialized as following.
-
-```python
-from bandwidth.bandwidth_client import BandwidthClient
-
-client = BandwidthClient(
-    messaging_basic_auth_user_name='MessagingBasicAuthUserName',
-    messaging_basic_auth_password='MessagingBasicAuthPassword',
-    voice_basic_auth_user_name='VoiceBasicAuthUserName',
-    voice_basic_auth_password='VoiceBasicAuthPassword',
-    environment = Environment.PRODUCTION,)
-```
-
-API calls return an `ApiResponse` object that includes the following fields:
-
-| Field | Description |
-|  --- | --- |
-| `status_code` | Status code of the HTTP response |
-| `reason_phrase` | Reason phrase of the HTTP response |
-| `headers` | Headers of the HTTP response as a dictionary |
-| `text` | The body of the HTTP response as a string |
-| `request` | HTTP request info |
-| `errors` | Errors, if they exist |
-| `body` | The deserialized body of the HTTP response |
-
-## Authorization
-
-This API does not require authentication.
-
-## API Reference
-
-### List of APIs
-
-*
-
+# Bandwidth Python SDK
+  
+Bandwidth's API docs can be found at https://dev.bandwidth.com
+
+Python specific docs can be found at https://dev.bandwidth.com/sdks/python.html
+
+# Python SDK
+
+## Download & Install
+
+```
+pip install bandwidth-sdk
+```
+
+## Initialize Bandwidth Client
+
+```python
+from bandwidth.bandwidth_client import BandwidthClient
+
+from bandwidth.messaging.models.message_request import MessageRequest
+from bandwidth.messaging.exceptions.generic_client_exception import GenericClientException
+from bandwidth.messaging.exceptions.path_client_exception import PathClientException
+
+from bandwidth.voice.models.api_create_call_request import ApiCreateCallRequest
+from bandwidth.voice.models.modify_call_recording_state import ModifyCallRecordingState
+from bandwidth.voice.exceptions.error_response_exception import ErrorResponseException
+from bandwidth.voice.bxml.response import Response
+from bandwidth.voice.bxml.verbs import *
+
+##Initialize client
+voice_basic_auth_user_name = 'username'
+voice_basic_auth_password = 'password'
+messaging_basic_auth_user_name = 'token'
+messaging_basic_auth_password = 'secret'
+
+bandwidth_client = BandwidthClient(
+    voice_basic_auth_user_name=voice_basic_auth_user_name,
+    voice_basic_auth_password=voice_basic_auth_password,
+    messaging_basic_auth_user_name=messaging_basic_auth_user_name,
+    messaging_basic_auth_password=messaging_basic_auth_password)
+```
+
+## Create Phone Call
+
+```python
+voice_client = bandwidth_client.voice_client.client
+account_id = "1"
+
+##Create phone call
+body = ApiCreateCallRequest()
+body.mfrom = "+17777777777"
+body.to = "+16666666666"
+body.application_id = "3-d-4-b-5"
+body.answer_url = "https://test.com"
+
+try:
+    response = voice_client.create_call(account_id, body=body)
+    print(response.body.call_id) #c-3f758f24-a59bb21e-4f23-4d62-afe9-53o2ls3o4saio4l
+    print(response.status_code) #201
+except ErrorResponseException as e:
+    print(e.description) #Invalid from: must be an E164 telephone number
+    print(e.response_code) #400
+```
+
+## Generate BXML
+
+```python
+response = Response()
+speak_sentence = SpeakSentence(
+    sentence="Test",
+    voice="susan",
+    locale="en_US",
+    gender="female"
+)
+
+response.add_verb(speak_sentence)
+print(response.to_bxml())
+```
+
+## Send Text Message
+
+```python
+messaging_client = bandwidth_client.messaging_client.client
+account_id = "1"
+
+body = MessageRequest()
+body.application_id = "1-d-b"
+body.to = ["+17777777777"]
+body.mfrom = "+18888888888"
+body.text = "Greetings!"
+
+try:
+    response = messaging_client.create_message(account_id, body=body)
+    print(response.body.id) #1570819529611mexbyfr7ugrouuxy
+    print(response.status_code) #202
+except GenericClientException as e:
+    print(e.description) #Your request could not be accepted.
+    print(e.response_code) #400
+except PathClientException as e:
+    print(e.message) #Access is denied
+    print(e.response_code) #403
+```

bandwidth/messaging/controllers/api_controller.py

@@ -9,6 +9,7 @@
 from bandwidth.api_helper import APIHelper
 from bandwidth.configuration import Server
 from bandwidth.http.api_response import ApiResponse
+from bandwidth.utilities.file_wrapper import FileWrapper
 from bandwidth.messaging.controllers.base_controller import BaseController
 from bandwidth.http.auth.messaging_basic_auth import MessagingBasicAuth
 from bandwidth.messaging.models.media import Media
@@ -191,7 +192,7 @@ def upload_media(self,
                      media_id,
                      content_length,
                      body,
-                     content_type=None,
+                     content_type='application/octet-stream',
                      cache_control=None):
         """Does a PUT request to /users/{userId}/media/{mediaId}.
 
@@ -203,6 +204,7 @@ def upload_media(self,
             content_length (long|int): TODO: type description here.
             body (string): TODO: type description here.
             content_type (string, optional): TODO: type description here.
+                Example: application/octet-stream
             cache_control (string, optional): TODO: type description here.
 
         Returns:
@@ -226,15 +228,22 @@ def upload_media(self,
         _query_builder += _url_path
         _query_url = APIHelper.clean_url(_query_builder)
 
+        if isinstance(body, FileWrapper):
+            body_wrapper = body.file_stream
+            body_content_type = body.content_type
+        else:
+            body_wrapper = body
+            body_content_type = content_type
+
         # Prepare headers
         _headers = {
+            'content-type': body_content_type,
             'Content-Length': content_length,
-            'Content-Type': content_type,
             'Cache-Control': cache_control
         }
 
         # Prepare and execute request
-        _request = self.config.http_client.put(_query_url, headers=_headers, parameters=body)
+        _request = self.config.http_client.put(_query_url, headers=_headers, parameters=body_wrapper)
         MessagingBasicAuth.apply(self.config, _request)
         _response = self.execute_request(_request)
 

bandwidth/utilities/__init__.py

@@ -0,0 +1,3 @@
+__all__ = [
+    'file_wrapper.py',
+]

bandwidth/utilities/file_wrapper.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+"""
+bandwidth
+
+This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+"""
+
+
+class FileWrapper():
+
+    """A wrapper to allow passing in content type for file uploads."""
+
+    def __init__(self, file, content_type='application/octet-stream'):
+        self._file_stream = file
+        self._content_type = content_type
+
+    @property
+    def file_stream(self):
+        return self._file_stream
+
+    @property
+    def content_type(self):
+        return self._content_type

bandwidth/voice/bxml/verbs/phone_number.py

@@ -15,13 +15,15 @@
 
 class PhoneNumber(AbstractBxmlVerb):
 
-    def __init__(self, number=None, transfer_answer_url=None, transfer_answer_method=None, username=None, password=None, tag=None):
+    def __init__(self, number=None, transfer_answer_url=None, transfer_answer_method=None, username=None, password=None, tag=None, transfer_disconnect_url=None, transfer_disconnect_method=None):
         """
         Initializes the PhoneNumber class with the following parameters
 
         :param str number: The phone number
         :param str transfer_answer_url: The url to send the transfer event to
         :param str transfer_answer_method: The http method of the transfer event request
+        :param str transfer_disconnect_url: The url to send the transfer disconnect event to
+        :param str transfer_disconnect_method: The http method of the transfer disconnect event request
         :param str username: The username to authenticate on the transfer event url
         :param str password: The password to authenticate on the transfer event url
         :param str tag: Custom string sent in the callback
@@ -32,6 +34,8 @@ def __init__(self, number=None, transfer_answer_url=None, transfer_answer_method
         self.username = username
         self.password = password
         self.tag = tag
+        self.transfer_disconnect_method = transfer_disconnect_method
+        self.transfer_disconnect_url = transfer_disconnect_url
 
     def to_etree_element(self):
         """
@@ -52,6 +56,10 @@ def to_etree_element(self):
             root.set("password", self.password)
         if self.tag is not None:
             root.set("tag", self.tag)
+        if self.transfer_disconnect_method is not None:
+            root.set("transferDisconnectMethod", self.transfer_disconnect_method)
+        if self.transfer_disconnect_url is not None:
+            root.set("transferDisconnectUrl", self.transfer_disconnect_url)
         return root
 
     def to_bxml(self):

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name='bandwidth-sdk',
-    version='5.2.0',
+    version='5.2.1',
     description='Bandwidth\'s set of APIs',
     long_description=long_description,
     long_description_content_type="text/markdown",

test-requirements.txt

@@ -1 +1 @@
-nose==1.3.7
+nose==1.3.7

tox.ini

@@ -1,7 +1,7 @@
 [tox]
-envlist = py27, py35
+envlist = py35
 
 [testenv]
 commands = nosetests
-deps = 
-    nose
+deps =
+    nose