Personal Cloud Storage SDK for Python Version 1.4 Release Guide

Release date 02/14/2017

Contents

 

 

Introduction

The following features are included in this release. Refer to the sections below for detailed listing of supported APIs.

The SDK Python Kepler Cloud File Explorer
Authentication and authorization Authentication and authorization
Account information Account information
Contacts* Contacts*
Favorites* Favorites*
File and Folder Operations File and Folder Operations
Playlists Playlists
Shares* Shares*
Tags* Tags*
Trash Trash
Virtual Folders* Virtual Folders*

* New in this release

Supported API calls

The following is a list of the API calls that are supported by the Python SDK and Python Kepler Cloud File Explorer. The list is of classes included in the SDK follows.

Class Cloud is the gateway to access Personal Cloud Storage APIs. Included in this class are all main methods that you can use to make the API calls.

  • Authentication and Authorization
    • authorize_url - Obtains a URL used to start the OAuth 2.0 authorization flow.
    • refresh - uses a refresh token to obtain a new access token
    • token - exchanges an authorization code for an access and a refresh tokens.
  • Account Information
    • account - retrieves account information.
  • Contacts
    • contacts - retrieves contacts.
  • Favorites
    • favorite - adds files and folders to favorites.
    • favorites - lists favorite files and folders.
    • unfavorite - removes files and folders from favorites.
  • File and Folder Operations
    • copy - creates a copy of a file or folder.
    • create_folder - creates a folder.
    • delete - deletes a file or folder.
    • download_url - retrieves a download URL for a file.
    • file_metadata - retrieves the metadata for a file.
    • fullview - obtains information on all files and folders.
    • metadata - retrieves the metadata of a folder.
    • move - moves a file or folder.
    • rename - renames a file or folder.
    • search - searches for a file or folder.
    • upload - uploads a file.
  • Playlists
    • add_playlist_items - adds items to a playlist.
    • create_playlist - creates a playlist.
    • delete_playlist- deletes a playlist.
    • playlist - retrieves a playlist’s definition.
    • playlist_items - retrieves the items in a playlist.
    • playlists - retrieves all playlists.
    • remove_playlist_item - removes an item from a playlist.
    • update_playlist - updates the metadata of the playist.
    • update_playlist_definition - updates the metadata and items of a playlist.
  • Shares
    • share - shares a list of files or folders.
    • shares - retrieves shared files and folders.
    • unshare - removes a file or folder from shares.
  • Tags
    • tag - tags a file or folder.
    • tags - retrieves a list of tagged files or folders.
    • untag - removes tags from file or folder.
  • Trash
    • empty_trash - permenantly removes all files and folders from the trash.
    • restore - restores a deleted file or folder.
    • trash - retrieves a list of deleted files and folders.
  • Virtual Folders
    • create_virtualfolder - creates a virtual folder.
    • delete_vitualfolder - deletes a virtual folder.
    • rename_virtualfolder - renames a virtual folder.

Classes

  • Main SDK Classes

  • Authentication and Authorization Classes

  • Response Classes

    • Account - represents a user’s ID and storage usage.
    • CloudFile - represents a file stored in a user’s cloud.
    • CloudFolder - represents a folder stored in a user’s cloud.
    • Contact - represents a contact in a user’s address book.
    • Playlist - represents a playlist stored in a user’s cloud.
    • PlaylistAdd - represents an item added to a playlist.
    • PlaylistItem - represents a file in a user’s playlist.
    • Sharerepresents a shared file or folder
    • ShareCursor - is used to paginate through the results of shares operation.
    • ShareRequest - share request object used to share files or folders

Copyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.