@jc-rowland/sharefile-node-api v0.4.5

ShareFileAPI

This is a TypeScript class that provides methods to interact with the ShareFile API.

Usage

// Import the necessary modules
import ShareFileAPI from '@jc-rowland/sharefile-node-api'
// Create an API instance
const shareFileAPI = new ShareFileAPI({
    subdomain   : 'subdomain',
    username    : 'username',
    password    : 'password',
    clientId    : 'clientId',
    clientSecret: 'clientSecret'
  });
// Authenticate
shareFileAPI.connect()
  .then(() => {
    // Authentication successful, ready to use the API
  });

Sharefile API Methods

items(id?: string)

This method retrieves a single ShareFile item by its ID. The ID can also be one of the following special values:

• home: Returns the home folder.
• favorites: Returns the parent favorite item.
• allshared: Returns the parent Shared Folders item.
• connectors: Returns the parent Connectors item.
• box: Returns the FileBox folder.
• top: Returns the Top item.

shareFileAPI.items('abcd-abcd-abcd1234abcd-ab12-cdef')
  .then((item: SharefileItem) => {
    // Process the item
  });

shareFileAPI.items('favorites')
  .then((item: SharefileItem) => {
    // Process the item
  });

itemsByPath(path: string)

This method retrieves a ShareFile item by its path. The path should be in the format /foldername/foldername/filename.

shareFileAPI.itemsByPath('/Shared Folders/Some Other Folder/somefile.ext')
  .then((item: SharefileItem) => {
    // Process the item
  });

SharefileItem methods