boxsdk package

Subpackages

• boxsdk.auth package
  • Submodules
  • boxsdk.auth.cooperatively_managed_oauth2 module
  • boxsdk.auth.developer_token_auth module
  • boxsdk.auth.jwt_auth module
  • boxsdk.auth.oauth2 module
  • boxsdk.auth.redis_managed_jwt_auth module
  • boxsdk.auth.redis_managed_oauth2 module
  • boxsdk.auth.remote_managed_oauth2 module
  • Module contents
• boxsdk.client package
  • Submodules
  • boxsdk.client.client module
  • boxsdk.client.developer_token_client module
  • boxsdk.client.development_client module
  • boxsdk.client.logging_client module
  • Module contents
• boxsdk.network package
  • Submodules
  • boxsdk.network.default_network module
  • boxsdk.network.network_interface module
  • Module contents
• boxsdk.object package
  • Submodules
  • boxsdk.object.api_json_object module
  • boxsdk.object.base_api_json_object module
  • boxsdk.object.base_endpoint module
  • boxsdk.object.base_object module
  • boxsdk.object.cloneable module
  • boxsdk.object.collaboration module
  • boxsdk.object.collaboration_whitelist module
  • boxsdk.object.collaboration_whitelist_entry module
  • boxsdk.object.collaboration_whitelist_exempt_target module
  • boxsdk.object.collection module
  • boxsdk.object.comment module
  • boxsdk.object.device_pinner module
  • boxsdk.object.email_alias module
  • boxsdk.object.enterprise module
  • boxsdk.object.event module
  • boxsdk.object.events module
  • boxsdk.object.file module
  • boxsdk.object.file_version module
  • boxsdk.object.file_version_retention module
  • boxsdk.object.folder module
  • boxsdk.object.group module
  • boxsdk.object.group_membership module
  • boxsdk.object.invite module
  • boxsdk.object.item module
  • boxsdk.object.legal_hold module
  • boxsdk.object.legal_hold_policy module
  • boxsdk.object.legal_hold_policy_assignment module
  • boxsdk.object.metadata module
  • boxsdk.object.metadata_cascade_policy module
  • boxsdk.object.metadata_template module
  • boxsdk.object.recent_item module
  • boxsdk.object.retention_policy module
  • boxsdk.object.retention_policy_assignment module
  • boxsdk.object.search module
  • boxsdk.object.storage_policy module
  • boxsdk.object.storage_policy_assignment module
  • boxsdk.object.task module
  • boxsdk.object.task_assignment module
  • boxsdk.object.terms_of_service module
  • boxsdk.object.terms_of_service_user_status module
  • boxsdk.object.trash module
  • boxsdk.object.upload_session module
  • boxsdk.object.user module
  • boxsdk.object.watermark module
  • boxsdk.object.web_link module
  • boxsdk.object.webhook module
  • Module contents
• boxsdk.pagination package
  • Submodules
  • boxsdk.pagination.box_object_collection module
  • boxsdk.pagination.dict_page module
  • boxsdk.pagination.limit_offset_based_dict_collection module
  • boxsdk.pagination.limit_offset_based_object_collection module
  • boxsdk.pagination.marker_based_dict_collection module
  • boxsdk.pagination.marker_based_object_collection module
  • boxsdk.pagination.page module
  • Module contents
• boxsdk.session package
  • Submodules
  • boxsdk.session.box_request module
  • boxsdk.session.box_response module
  • boxsdk.session.session module
  • Module contents
• boxsdk.util package
  • Submodules
  • boxsdk.util.api_call_decorator module
  • boxsdk.util.chain_map module
  • boxsdk.util.compat module
  • boxsdk.util.enum module
  • boxsdk.util.json module
  • boxsdk.util.log module
  • boxsdk.util.lru_cache module
  • boxsdk.util.multipart_stream module
  • boxsdk.util.shared_link module
  • boxsdk.util.text_enum module
  • boxsdk.util.translator module
  • Module contents

Submodules

boxsdk.config module

class boxsdk.config.API

Bases: object

Configuration object containing the URLs for the Box API.

BASE_API_URL = u'https://api.box.com/2.0'

OAUTH2_API_URL = u'https://api.box.com/oauth2'

OAUTH2_AUTHORIZE_URL = u'https://account.box.com/api/oauth2/authorize'

UPLOAD_URL = u'https://upload.box.com/api/2.0'

class boxsdk.config.Client

Bases: object

Configuration object containing the user agent string.

BOX_UA_STRING = u'agent=box-python-sdk/2.0.0; env=python/2.7.12'

USER_AGENT_STRING = u'box-python-sdk-2.0.0'

VERSION = u'2.0.0'

boxsdk.exception module

exception boxsdk.exception.BoxException

Bases: exceptions.Exception

Base class exception for all errors raised from the SDK.

exception boxsdk.exception.BoxAPIException(status, code=None, message=None, request_id=None, headers=None, url=None, method=None, context_info=None, network_response=None)

Bases: boxsdk.exception.BoxException

Exception raised from the box session layer.

Parameters:

• status (int) – HTTP status code of the failed response
• code (unicode or None) – The ‘code’ field of the failed response
• message (unicode or None) – A message to associate with the exception, e.g. ‘message’ field of the json in the failed response
• request_id (unicode or None) – The ‘request_id’ field of the json in the failed response
• headers (dict) – The HTTP headers in the failed response
• url (unicode) – The url which raised the exception
• method (unicode) – The HTTP verb used to make the request.
• context_info (dict or None) – The context_info returned in the failed response.
• network_response (Requests Response) – The failed response

code

context_info

headers

message

method

network_response

request_id

status

url

exception boxsdk.exception.BoxOAuthException(status, message=None, url=None, method=None, network_response=None, code=None)

Bases: boxsdk.exception.BoxException

Exception raised during auth.

Parameters:

• status (int) – HTTP status code of the auth response
• message (unicode) – A message to associate with the exception, e.g. HTTP content of the auth response
• url (unicode) – The url which raised the exception
• method (unicode) – The HTTP verb used to make the request.
• network_response (NetworkResponse) – The network response for the request.
• code (unicode or None) – The ‘code’ field of the failed response

code

message

method

network_response

status

url

exception boxsdk.exception.BoxNetworkException

Bases: boxsdk.exception.BoxException

Exception raised from the network layer.

boxsdk.version module

Module contents