Ruby 1.6 Release Guide

Personal Cloud Storage SDK for Ruby Version 1.6 Release Guide

Release date 03/23/2017

Contents

 

 

Introduction

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

The SDK PHP 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
File upload File upload
Playlists Playlists
Shares Shares
Tags Tags
Trash Trash
Virtual Folders Virtual Folders

* Updated in this release to allow you to create, retrieve, update, and delete contacts.

Supported API calls

  • Authentication and Authorization

    • POST /oauth2/token - obtains access token.
  • Account Information

    • account_info - retrieves account information.
  • Contacts

    • createContact - creates specified contact.
    • deleteConatct - deletes specified contact.
    • contacts - retrieves all contacts or a subset of contacts.
    • updateContact - updates specified contact.
  • Favorites

    • deleteFavorites - deletes favorites.
    • getFavorites - retrieves favorites.
    • setFavorites - adds files and folders to favorites.
  • File and Folder Operations

    • create_folder - creates folder.
    • file_delete - deletes a file.
    • file_copy - copies a file or folder.
    • file_move - moves fa ile or folder.
    • fileorfolder_rename - renames a file or folder.
    • fullview - retrieves information on all files and folders.
    • get_file - retrieves file content.
    • metadata - retrieves metadata for files or folders.
    • search - search for files or folders
    • thumbnail - retrieves thumbnails for image files.
  • File Upload

    • fileUploadIntent - initiates file upload intent.
    • upload_chunk_data - performs chunked file upload.
    • uploadCommit - completes chunked file upload.
    • upload_data - performs non-chunked file upload.
  • Playlists

    • add_playlist_item - adds item to playlist.
    • create_playlist - creates a playlist.
    • deletePlaylist - deletes a playlist.
    • deletePlaylistItem - deletes an item from a playlist.
    • playlistContent - retrieves playlist content.
    • playlistDefinition - retrieve playlist definition.
    • playlistItems - lists items in a playlist.
    • playlists - retrieves playlist.
    • update_playlist - updates playlist.
    • update_playlist_items - updates playlist item definition.
  • Shares

    • createShare - creates a share.
    • deleteShare - deletes a share.
    • getShares - retrieves a share.
  • Tags

    • deleteTags - deletes tags.
    • getTags - retrieves tags.
    • setTags - update tags.
  • Trash Can

    • purgetrash - permanently removes deleted files and folders.
    • restore - restores deleted files or folders.
    • trash - fetrieves the list of deleted files and folders.
  • Virtual Foldes

    • createVirtualFolder - creates a virtual folder.
    • deleteVirtualFolder - deletes a virtual folder.
    • renameVirtualFolder - renames a virtual folder.

Classes

  • Main SDK Classes

    • Sdk
    • SdkClient - used to make API calls.
  • Authentication and Authorization Classes

    • OAuthToken - represents OAuth 2.0 request and access tokens.
    • SdkOAuth2Flow - OAuth 2.0 authorization helper.
    • SdkOAuth2FlowBase - base class for OAuth 1.0 and OAuth 2.0 authorization helpers
    • SdkOAuth2FlowNoRedirect - OAuth 2.0 authorization helper for apps that can’t provide redirect URI
    • SdkOAuth2Session - OAuth 2.0 Session
    • SdkSession - stores OAuth 1.0 Information.
    • SdkSessionBase
  • SDK Classes

    • Account -account information
    • Contact - contacts
    • Fileops - file and folder operations
    • Playlist - playlists
    • Share - shares
    • Tag - tags
    • Virtualfolder - virtual folders
  • Error Classes

    • BadRequestError - bad request error class
    • BadStateError - bad state error class
    • CsrfError - CSRF error class
    • NotApprovedError - authorization error class
    • SdkNotModified - error class
    • ProviderError - provider error class
    • SdkAuthError - authentication error class
    • SdkError - server error class

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