Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ used to interact with the Box API. This is a list of contributors.
- `@hnguyen08 <https://github.com/hnguyen08>`_
- `@potrebic <https://github.com/potrebic>`_
- `@nsundareswaran <https://github.com/nsundareswaran>`_
- `@kelseymorris95 <https://github.com/kelseymorris95>`_
9 changes: 3 additions & 6 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@
Release History
---------------

Upcoming
++++++++

New Release?
++++++++++++++++++
2.0.0 (Upcoming)
++++++++++++++++

**Breaking Changes**

Expand Down Expand Up @@ -40,7 +37,7 @@ New Release?
``BaseAPIJSONObject``, ``APIJSONObject``, was created to represent pseudo-smart objects such as ``Event`` that are not
directly accessible through an API endpoint.

1.5.3
1.5.3 (2016-05-26)
++++++++++++++++++

- Bugfix so that ``JWTAuth`` opens the PEM private key file in ``'rb'`` mode.
Expand Down
12 changes: 12 additions & 0 deletions boxsdk/exception.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ def __unicode__(self):
def status(self):
"""
The status code of the network response that is responsible for the exception.

:rtype: `int`
"""
return self._status
Expand All @@ -110,18 +111,25 @@ def status(self):
def code(self):
"""
The explanation of the status code of the network response that is responsible for the exception.

:rtype: `int`
"""
return self._code

@property
def message(self):
"""
The message associated with the exception, e.g. 'message' field of the json in the failed response.

:rtype: `unicode`
"""
return self._message

@property
def request_id(self):
"""
The id the network request that is responsible for the exception.

:rtype: `unicode`
"""
return self._request_id
Expand All @@ -130,6 +138,7 @@ def request_id(self):
def url(self):
"""
The URL of the network request that is responsible for the exception.

:rtype: `unicode`
"""
return self._url
Expand All @@ -138,6 +147,7 @@ def url(self):
def method(self):
"""
The HTTP verb of the request that is responsible for the exception.

:rtype: `unicode`
"""
return self._method
Expand All @@ -146,6 +156,7 @@ def method(self):
def context_info(self):
"""
The context_info returned in the failed response.

:rtype: `dict`
"""
return self._context_info
Expand All @@ -154,6 +165,7 @@ def context_info(self):
def network_response(self):
"""
The response returned from the network.

:rtype: `NetworkResponse`
"""
return self._network_response
Expand Down
1 change: 1 addition & 0 deletions boxsdk/network/default_network.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ def access_token_used(self):
def request_response(self):
"""
The response returned from the Requests library.

:rtype: `Response`
"""
return self._request_response
1 change: 1 addition & 0 deletions boxsdk/object/base_api_json_object.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ def _description(self):
def response_object(self):
"""
Return the JSON object representing the object returned from a Box API request.

:rtype:
`dict`
"""
Expand Down
3 changes: 3 additions & 0 deletions boxsdk/object/cloneable.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ class Cloneable(object):
def as_user(self, user):
"""
Returns a new endpoint object with default headers set up to make requests as the specified user.

:param user:
The user to impersonate when making API requests.
:type user:
Expand All @@ -22,6 +23,7 @@ def as_user(self, user):
def with_shared_link(self, shared_link, shared_link_password):
"""
Returns a new endpoint object with default headers set up to make requests using the shared link for auth.

:param shared_link:
The shared link.
:type shared_link:
Expand All @@ -36,6 +38,7 @@ def with_shared_link(self, shared_link, shared_link_password):
def clone(self, session=None):
"""
Returns a copy of this cloneable object using the specified session.

:param session:
The Box session used to make requests.
:type session:
Expand Down
2 changes: 1 addition & 1 deletion boxsdk/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
from __future__ import unicode_literals, absolute_import


__version__ = '1.5.3'
__version__ = '2.0.0a1'
32 changes: 32 additions & 0 deletions docs/source/boxsdk.object.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ boxsdk.object package
Submodules
----------

boxsdk.object.api_json_object module
------------------------------------

.. automodule:: boxsdk.object.api_json_object
:members:
:undoc-members:
:show-inheritance:

boxsdk.object.base_api_json_object module
-----------------------------------------

.. automodule:: boxsdk.object.base_api_json_object
:members:
:undoc-members:
:show-inheritance:

boxsdk.object.base_endpoint module
----------------------------------

Expand All @@ -20,6 +36,14 @@ boxsdk.object.base_object module
:undoc-members:
:show-inheritance:

boxsdk.object.cloneable module
------------------------------

.. automodule:: boxsdk.object.cloneable
:members:
:undoc-members:
:show-inheritance:

boxsdk.object.collaboration module
----------------------------------

Expand All @@ -28,6 +52,14 @@ boxsdk.object.collaboration module
:undoc-members:
:show-inheritance:

boxsdk.object.event module
--------------------------

.. automodule:: boxsdk.object.event
:members:
:undoc-members:
:show-inheritance:

boxsdk.object.events module
---------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/source/boxsdk.util.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ boxsdk.util package
Submodules
----------

boxsdk.util.api_call_decorator module
-------------------------------------

.. automodule:: boxsdk.util.api_call_decorator
:members:
:undoc-members:
:show-inheritance:

boxsdk.util.compat module
-------------------------

Expand Down