Version 1.3 - Updated on 01/12/2017
Cloud(client\_key, client\_secret, callback\_url [, access\_token [, refresh\_token [, on\_refreshed ]]]
The Python SDK Personal Cloud Storage class. For most applications, you there is one instance of this class for each user.
client_key — Key obtained from the ThingSpace portalclient_secret — Secret obtained from the ThingSpace portalcallback_url — Callback URL obtained from the ThingSpace portal.access_token - Optional OAuth 2.0 access token that allows the SDK to immediately begin making authenticated calls.refresh_token - Optional OAuth 2.0 refresh token.on_refreshed — Callback function you can use to refresh tokens. Passes the Token object as the only argument.authorize_urlcloud.authorize_url()
Obtains a URL used to start the OAuth 2.0 authorization flow. The URI prompts the users to log on and grant access to their Personal Cloud Storage content.
refreshcloud.refresh()
Called when an OAuth 2.0 access token expires. Uses a refresh token to obtain a new access token. This call fails if the refresh token has expired.
This method id called internally by the SDK, when an expired access token is detected.
Token object containing the access\_token and the refresh\_token.CloudError — HTTP request failureUnauthorizedError — The user provided a bad or expired refresh token.tokencloud.token(auth_code)
The second part of the standard OAuth 2.0 authorization flow. Uses an authorization code obtained through the OAuth 2.0 redirect_uri to obtain an access and refresh tokens, used to access an user’s Cloud Storage content.
auth_code — OAuth 2.0 auth code obtained from the callback.Token object containing the access\_token and refresh\_token. The SDK may begin making authenticated calls after a successful tokens call.CloudError — HTTP request failureUnauthorizedError — The user provided a bad auth\_code.accountcloud.account()
Retrieves the account information.
Account object containing a user’s quota usage and id.CloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired token.copycloud.copy(file\_or\_path, target\_path [, safe [, override [, conflictsolve ]]])
Copies a file or folder.
file_or_path — Path where the folder or a file is to be copied fromtarget_path — Path where the folder or a file is to be copied tosafe - If set to true, ensures that name conflicts are resolved according to the value of the conflictsolve parameter. Defaults to false, in which case the operation overwrites an existing file or folder of the same name.override - Specifies what happens when a folder of the same name already exists at the specified path:conflictsolve - Defines how name conflicts are resolved when safe parameter is set to true. If conflictsolve is set to copy, a new file is written to the destination folder with a non-conflicting name. If conflictsolve is not set, the file is not copied and a ConflictError is raised.ConflictError - Occurs when safe is set to true and there is a conflict.NotFoundError - Path not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokencreate_foldercloud.create_folder\_url(path [, override ])
Creates a folder.
path — Path where the folder is to be createdoverride — Specifies what happens when a folder of the same name already exists at the specified path:CloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokendeletecloud.delete(file\_or\_path [, purge ])
Deletes a file or folder.
file_or_path — a CloudFile or the path of the file to be deleted.purge — If set to true, permanently deletes a file or folder. Defaults to false.NotFoundError - The path not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokendownloadcloud.download\_url(file_or_path)
Retrieves a download URL for a CloudFile object
file_or_path — a CloudFile or the path of the file to be downloaded.file_metadatacloud.file_metadata(path)
Retrieves metadata for a file.
path — Path to the fileCloudFile containing the metadata of the fileCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenNotFoundError - The resource was not found.fullviewcloud.fullview(etag)
Obtains information on all files and folders in a user’s Personal Cloud Storage account.
Return value contains a property etag. Use etag as an argument to a fullview call to retrieve changes between two subsequent fullview calls.
etag — Lucene style search queryfiles - array of CloudFile objectsempty_folders - Array of empty CloudFolder Objects in the user’s cloudetag - Etag used in subsequent fullview calls to retrieve the changes to the content of a user’s Personal Cloud Storage accountdeleted - Array of paths that have been deleted since the last fullview callCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenOutOfSyncError - Specified etag is too far out of date. Delete cached files and resync by calling fullview without etag.metadatacloud.metadata(path)
Retrieves the metadata of a folder. The response includes the metadata for the folder’s contents, including files and subfolders.
path — Current folder’s path and name. Defaults to the root /.files - array of CloudFile objectsfolders - array of CloudFolder objectsCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenNotFoundError - The resource was not found.movecloud.move(file\_or\_path, target\_path [, safe [, conflictsolve ]])
Moves a file or folder.
file_or_path — Path where the folder or a file is to be moved from.target_path — Path where the folder or a file is to be moved to.safe - If set to true, ensures that name conflicts are resolved according to the value of the conflictsolve parameter. Defaults to false, in which case the operation overwrites an existing file or folder of the same name.override - Specifies what happens when a folder of the same name already exists at the specified path:conflictsolve - Defines how name conflicts are resolved when safe parameter is set to true. If conflictsolve is set to copy, a new file is written to the destination folder with a non-conflicting name. If conflictsolve is not set, the file is not copied and a ConflictError is raised.NotFoundError - The path not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenrenamecloud.rename(file\_or\_path, target\_path [, safe [, conflictsolve ]]) Renames a file or folder
file_or_path — Path to the file or folder to be renamedtarget_path — Path to the renamed file or foldersafe - If set to true, ensures that name conflicts are resolved according to the value of the conflictsolve parameter. Defaults to false, in which case the operation overwrites an existing file or folder of the same name.override - Specifies what happens when a folder of the same name already exists at the specified path:conflictsolve - Defines how name conflicts are resolved when safe parameter is set to true. If conflictsolve is set to copy, a new file is written to the destination folder with a non-conflicting name. If conflictsolve is not set, the file is not copied and a ConflictError is raised.NotFoundError - The path was not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, the user has a bad or expired tokensearchcloud.search(query [, sort [, virtualfolder [, page [, count]]]])
Searches for files or folders.
query — Lucene style search querysort - Optional sort parameter. Syntax is: {field}+{asc or desc}.virtualfolder - Optional virtualfolder to search in. Default is VZMOBILE.page - Optional page number. Default is 1.count - Optional number of results to return. Default is 20, max is 100.files - array of CloudFile objectsfolders - array of CloudFolder objectsCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenuploadcloud.upload(file\_or\_path, upload\_path [, name [, chunked [, chunk_size ]]])
Uploads a file.
file_or_path — Either a file object or a path from where the file is to be uploaded.upoad_path - Path where the file is to be uploaded toname - Optional. New name of the file, defaults to the current name.chunked - Optional. If set to true, forces smaller files to be uploaded in chunks.chunk_size - Optional chunk size in bytes.CloudFile object containing metadata of the uploaded fileCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenadd_playlist_itemscloud.add_playlist_items(playlist_uid, playlist_items)
Adds items to a playlist.
playlist_uid - playlist uid returned from a playlists callplaylist_items - array of paths to the items that are to be addedPlaylistAdd objectsCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokencreate_playlistcloud.create_playlist(name, type, paths)
Retrieves the items in a playlist.
name - Name of the playlisttype -The type of the playlist which can be one of the following:paths - array of paths to the itemsPlaylist objectCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokendelete_playlistcloud.delete_playlist(playlist_uid)
Deletes a playlist.
playlist_uid - playlist UID returned from a playlists callNotFoundError - The playlist is not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenplaylistcloud.playlist(playlist_uid)
Retrieves a single playlist’s definition.
playlist_uid - playlist uid returned from a playlists callPlaylist objectNotFoundError - The playlist is not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenplaylist_itemscloud.playlist_items(playlist_uid [, page [, count [, sort ]]])
Retrieves the items in a playlist.
playlist_uid - playlist uid returned from a playlists callpage - Optional page number, defaults to 1.count - Optional number of results to return. Defaults to 20, max is 100.sort - Controls the sort order of the response. Syntax is {field}+{asc or desc}.PlaylistItem objectsCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenplaylistscloud.playlists( [, type [, page [, count [, sort ]]]])
Retrieves all playlists.
type -The type of the playlist which can be one of the following:page - Optional page number, defaults to 1.count - Optional number of results to return. Defaults to 20, max is 100.sort - Controls the sort order of the response. Syntax is {field}+{asc or desc}.Playlist objectsCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenremove_playlist_itemcloud.remove_playlist_item(playlist_uid, itemuid)
Removes an item from a playlist.
playlist_uid - playlist UID returned from a playlists callitemuid - playlist item returned from a playlist_items callNotFoundError - The playlist is not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenupdate_playlistcloud.update_playlist(playlist_uid, name, type)
Updates the metadata of the playist. This method does not alter a playlist’s contents.
playlist_uid - playlist’s UID returned from a playlists callname - name of the playlisttype -The type of the playlist which can be one of the following:Playlist objectNotFoundError - The playlist is not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenupdate_playlist_definitioncloud.update_playlist_definition(playlist_uid, name, type, paths)
Updates the metadata and items of a playlist.
playlist_uid - playlist UID returned from a playlists callname - name of the playlisttype -The type of the playlist which can be one of the following:paths - array of paths to the itemsPlaylist objectNotFoundError - The playlist is not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokenempty_trashcloud.empty_trash([virtualfolder]) Permenantly removes all files and folders from the trash.
Parameters:
virtualfolder - Optional virtual folder to empty, defaults to ‘VZMOBILE’.Returns: None
Errors:
NotFoundError - The virtual not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, a bad or expired tokenrestorecloud.restore(file\_or_\path)
Restores a file or folder.
file_or_path — a CloudFile or the path to the file or folder to be restored.NotFoundError - The file or folder not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, bad or expired tokentrashcloud.trash([virtualfolder [, sort [, page [, count [, deep [, filter ]]]]])
Retrieves a list of deleted files and folders.
Parameters:
virtualfolder - Optional virtualfolder to empty, defaults to ‘VZMOBILE’sort - Optional sort parameter. Syntax is: {field}+{asc or desc}.virtualfolder - Optional virtualfolder to search in, defaults to ‘VZMOBILE’page - Optional page number, defaults to 1count - Optional number of results to return. Defaults to 20, max is 100.filter - Optional filter, If set to file, returns files in the response. If set to folder, returns folders in the response. The default will return files and folders.Returns: files, folders
files - array of CloudFile objectsfolders - array of CloudFolder objectsErrors:
NotFoundError - The virtualfolder was not foundCloudError — HTTP request failureUnauthorizedError — Unauthorized, the user has a bad or expired tokenCopyright © 2015-2017, Verizon and/or its Licensors. All rights reserved.