mitquinn/box-api-sdk

This is an unofficial Box.com API SDK.

box-api-sdk

This is an unofficial Box.com API SDK.

Author: Mitchell Quinn mitchell.david.quinn@gmail.com

High Level Todo:

• Total Api Requests Included
• 60/188 Requests
• Estimated time for completion April 6th 25th
  • At a rate of 2 apis a day

General

• Create shared property traits - 1/9/21
• add shared traits to folder/files resources - 1/10/21
• Rename Collections to something else? 2/9/21
• Write ReadMe 1/27/21
• Create Technical Overview
• Copy over things that have been done to the new ReadMe 1/28/21
• Convert Dot -> Collections, Remove Dot
• Extract RecentItemsResource into a simple Entries abstract
• Refactored Resources to just be names of resources (removing "Resource" from class names)
• Need to refactor UseId to be not null AND string 3/10/21
• Extract all the resource mapping checks into a single static function?

Authorization Api

• AccessToken Resource
• Authorization Collection
• Authorize User
• Request Access Token
• Refresh Access Token
• Revoke Access Token

Classifications

• Add support for Classification Requests
• Add tests for Classification Requests
• Classification Collection 2/5/21
• Classification Resource
• Classification Template 2/7/21
• List All Classifications 2/7/21
• Add Initial Classification 2/7/21
• Add Classification 2/7/21
• Update Classification 2/7/21
• Delete Classification 2/7/21
• Delete All Classifications 2/7/21

Classifications on Files

• Get Classification on File
• Add Classification to File
• Update Classification on File
• Remove Classification from File

Classifications on Folders

• Get Classification on Folder
• Add Classification to Folder
• Update Classification on Folder
• Remove Classification from Folder

Collaborations

• Collaborations Collection 1/16/21
  • Refactored 2/5/21
• Collaboration Resource 1/14/21
• Collaborations Resource 1/17/21
• Get Collaboration 1/16/21
  • Refactored 2/5/21
• Create Collaboration 1/15/21
  • Refactored 2/5/21
• Update Collaboration 1/16/21
  • Refactored 2/5/21
• Remove Collaboration 1/16/21
  • Refactored 2/5/21

Collaborations (List)

• List File Collaborations 1/18/21
  • Refactored 2/3/21
• List Folder Collaborations 1/17/21
• List Pending Collaborations 1/18/21
  • Refactored 2/5/21
• List Collaborations for Group 1/18/21

Collections

• Collections Collection 2/9/21
• Collection Resource 2/9/21
• Collections Resource 2/9/21
• List all Collections 2/9/21
• List Collection items 2/9/21

Comments

• Comments Collection 2/11/21
• Comment Resource 2/11/21
• Comments Resource 2/11/21
• List File Comments 2/11/21
• Get Comment 2/11/21
• Create Comment 2/11/21
• Update Comment 2/11/21
• Remove Comment 2/11/21
• Add Tests for Comments 2/12/21

Device Pinners

• DevicePinners Collection
• DevicePinner Resource
• DevicePinners Resource
• Get Device Pin
• List Enterprise Device Pin
• Remove Device Pin

Domain Restrictions (User Exemptions)

• AllowedCollaborationDomainsUsers Collection
• AllowedCollaborationDomainsUserExemption Resource
• AllowedCollaborationDomainsUserExemptions Resource
• List Users exempt from collaboration domain restrictions
• Get User exempt from collaboration domain restrictions
• Create User exempt from collaboration domain restrictions
• Remove Users exempt from collaboration domain restrictions

Domain Restrictions for Collaborations

• AllowedCollaborationDomain Collection
• AllowedCollaborationDomain Resource
• AllowedCollaborationDomains Resource
• List allowed Collaboration Domains
• Get allowed Collaboration Domain
• Add Domain to list of allowed Collaboration Domains
• Remove Domain from list of allowed Collaboration Domains

Downloads

• Download file

Email Aliases

• EmailAlias Resource 2/14/21
• EmailAliases Resource 2/14/21
• EmailAliases Collection 2/14/21
• List user's email aliases 2/14/21
• Create email alias 2/14/21
• Remove email alias 2/14/21
• Test Email Aliases API 2/15/21

Events

• Event Resource 2/16/21
• Events Resource 2/16/21
• Event Source Resource
• Real-time servers
• List user and enterprise events 2/16/21
• Get events long pool endpoint

File Requests

• FileRequest Resource 2/17/21
• File Request Collection 2/17/21
• Get file request 2/17/21
• Copy file request 2/17/21
• Update file request 2/17/21
• Delete file request 2/17/21
• Test File Request Api

File Version Legal Holds

• FileVersionLegalHold Resource
• FileVersionLegalHolds Resource
• FileVersionLegalHolds Collection
• Get file version legal hold
• List file version legal holds

File Version Retentions

• FileVersionRetention Resource
• FileVersionRetentions Resource
• FileVersionRetentions Collection
• Get retention on file
• List file version retentions

File Versions

• FileVersion Resource
• FileVersions Resource
• FileVersions Collection
• List all File Version
• Get File Version
• Revert File Version
• Remove File Version

Files

• Files Collection 2/3/21
• File Resource 1/7/21
• File(Full) Resource 1/7/21
• File(Mini) Resource
• File(Base) Resource
• Files Resource 1/7/21
• Get File information 1/10/21
  • Refactored 2/3/21
• Get File Thumbnail 1/10/21
  • Refactored 2/3/21
• Copy File 1/11/21
  • Refactored 2/3/21
• Update File 2/3/21
• Delete File 1/10/21
  • Refactored 2/2/21

Folder Locks

• FolderLock Resource 2/18/21
• FolderLocks Resource 2/19/21
• FolderLocks Collection 2/18/21
• List Folder locks on folder 2/19/21
• Create Folder lock on folder 2/19/21
• Delete Folder lock 2/19/21
• Test Folder Locks Api 2/20/21

Folders

• Folder Resource 1/1/21
• Folder Full Resource 1/1/21
• Folder Mini Resource
• Folder Base Resource
• Items Resource 1/1/21
• Folders Collection 1/3/21
  • Refactored 2/1/21
• Get Folder Information 1/1/2
  • Refactored 2/1/21
• List items in folder 1/1/21
  • Refactored 2/1/21
• Create Folder 1/1/21
  • Refactored 1/30/21
• Copy Folder 1/3/21
  • Refactored 2/1/21
• Update Folder 1/3/21
  • Refactored 2/1/21
• Delete Folder 1/2/21
  • Refactored 1/30/21

Group Memberships

• GroupMembership Resource 1/21/21
• GroupMemberships Resource 1/20/21
• GroupMemberships Collection 1/23/21
  • Refactored 2/4/21
• List User's Groups 1/20/21
  • Refactored 2/4/21
• List members of Group 1/20/21
  • Refactored 2/4/21
• Get Group Membership 1/21/21
  • Refactored 2/4/21
• Add user to Group 1/22/21
  • Refactored 2/4/21
• Update Group Membership 1/22/21
  • Refactored 2/4/21
• Remove user from group 1/23/21
  • Refactored 2/4/21

Groups

• Group Resource 1/18/21
• Groups Resource 1/18/21
• Groups Collection 1/18/21
  • Refactored 2/4/21
• Group Base Resource 1/18/21
• Group Mini Resource 1/18/21
• Group Full Resource 1/18/21
• List Groups for enterprise 1/18/21
  • Refactored 2/4/21
• Get Group 1/18/21
  • Refactored 2/4/21
• Create Group 1/18/21
  • Refactored 2/4/21
• Update Group 1/18/21
  • Refactored 2/4/21
• Remove Group 1/18/21

Invites

• Invite Resource
• Invites Collection
• Get User Invite Status
• Create User Invite

Legal Hold Policies

• LegalHoldPolicy Resource
• LegalHoldPolicies Resource
• LegalHoldPolicy Mini Resource
• Legal Hold Policies Collection
• List Legal Hold Policy Assignments
• Get Legal Hold Policy Assignment
• List current file version for legal hold policy assignment
• List previous file versions for legal hold policy assignment
• Assign legal hold policy
• Unassign legal hold policy

Metadata Cascade Policies

• MetadataCascadePolicy Resource
• MetadataCascadePolicies Resource
• MetadataCascadePolicies Collection
• List Metadata Cascade Policies
• Get Metadata Cascade Policy
• Create metadata cascade policy
• Force-apply metadata cascade policy to folder
• Remove Metadata Cascade Policy

Metadata Instances (Files)

• MetadataInstance Resource
• MetadataInstance Full Resource
• MetadataInstance Base Resource
• MetadataInstances Resource
• MetadataInstances Collection
• List metadata instances on file
• Get metadata instance on file
• Create metadata instance on file
• Update metadata instance on file
• Remove metadata instance from file

Metadata Instances (Folders)

• List metadata instances on folder
• Get metadata instance on folder
• Create metadata instance on folder
• Update metadata instance on folder
• Remove metadata instance from folder

Metadata Templates

• Metadata template Resource
• Metadata templates Resource
• Metadata templates Collection
• Find metadata template by instance ID
• Get metadata template by name
• Get metadata template by ID
• List all global metadata templates
• List all metadata templates for enterprise
• Create metadata template
• Update metadata template
• Remove metadata template

Recent Items

• Recent Item Resource
• Recent Items Resource
• Recent Items Collection
• List Recently access items

Retention Polices

• Retention policies Resource
• Retention policies Collection
• Retention policy Resource
• Retention policy (Mini) Resource
• Retention policy (Base) Resource
• List retention policies
• Get retention policy
• Create retention policy
• Update retention policy

Retention Policy Assignments

• Retention policy assignment Resource
• Retention policy assignments Resource
• Retention policy assignments Collection
• List retention policy assignments
• Get retention policy assignment
• Assign retention policy

Search

• Metadata query search results Resource
• Search Results Resource
• Search Results (including Shared Links) Resource
• Search Result (including Shared Link) Resource
• Metadata filter Resource
• Search for content
• Query files/folders by metadata

Shared Links (Files)

• Find file for shared link
• Get shared link for file
• Add shared link to file
• Update shared link on file
• Remove shared link from file

Shared Links (Folders)

• Find folder for shared link
• Get shared link for folder
• Add shared link to folder
• Update shared link on folder
• Remove shared link from folder

Skills

• Skill webhook payload Resource
• Skills metadata instance Resource
• Skill Card Resource
• Keyword Skill Card Resource
• Timeline Skill Card Resource
• Transcript Skill Card Resource
• Status Skill Card Resource
• List Box Skill cards on file
• Create Box Skill cards on file
• Update Box Skill cards on file
• Update all Box Skill cards on file
• Remove Box Skill cards from file
• Skill Collection

Storage Polices

• Storage policy Resource
• Storage policies Resource
• Storage policies Collection
• Storage policy (Mini) Resource
• List storage policies
• Get storage policy

Storage Policy Assignments

• Storage policy assignment Resource
• Storage policy assignments Resource
• Storage policy assignments Collection
• List storage policy assignments
• Get storage policy assignment
• Assign storage policy
• Update storage policy assignment
• Unassign storage policy

Task Assignments

• Task assignment Resource 3/19/21
• Task assignments Resource
• Task assignments Collection
• List task assignments
• Get task assignment
• Assign task
• Update task assignment
• Unassign task

Tasks

• Task Resource 2/26/21
• Tasks Resource 2/26/21
• Tasks Api 2/23/21
• List tasks on file 2/23/21
• Get task 2/23/21
• Create task 2/23/21
• Update task 2/23/21
• Remove task 2/23/21
• Tests for Tasks Api 3/9/21

Terms of Service

• Terms of service Resource
• Terms of services Resource
• Terms of services Collection
• Terms of service (Mini) Resource
• List terms of services
• Get terms of service
• Create terms of service
• Update terms of service

Terms of Service User Statuses

• Terms of service user status Resource
• Terms of service user statuses Resource
• Terms of service user statuses Collection
• List terms of service user statuses
• Create terms of service status for new user
• Update terms of service status for existing user

Transfer Folders

• Transfer Owned Folders

Trashed Files

• Get trashed file
• Restore file
• Permanently remove file

Trashed Folders

• Get trashed folder
• Restore folder
• Permanently remove folder

Trashed Items

• List Trashed Items

Trashed Web Links

• Get trashed web link
• Restore web link
• Permanently remove web link

Uploads

• Conflict error Resource
• Upload URL Resource
• Preflight check before upload
• Upload file version
• Upload file
  • Refactored 2/2/21

Uploads (Chunked)

• Upload part Resource
• Upload part (Mini) Resource
• Uploaded part Resource
• Upload parts Resource
• Upload session Resource
• Get upload session
• List parts
• Create upload session
• Create upload session for existing file
• Commit upload session
• Upload part of file
• Remove upload session

User Avatars

• Get User Avatar

Users

• User Resource
• Users Resource 1/1/21
• Users Collection 1/1/21
  • Refactored 2/2/21
• User (Full) Resource 1/1/21
• User (Mini) Resource
• User (Base) Resource
• List enterprise users 1/1/21
  • Refactored 2/1/21
• Get current user 1/1/21
  • Refactored 2/1/21
• Get user 1/1/21
  • Refactored 2/2/21
• Create user
• Update user 1/1/21
  • Refactored 2/2/21
• Delete user

Watermarks (Files)

• Watermark Resource
• Watermark Collection
• Get watermark on file
• Apply watermark to file
• Remove watermark from file

Watermarks (Folders)

• Get watermark for folder
• Apply watermark to folder
• Remove watermark from folder

Web Links

• WebLink Resource 2/21/21
• Web link Api 2/21/21
• WebLinkMini Resource 2/21/21
• Get web link 2/21/21
• Create web link 2/21/21
• Update web link 2/21/21
• Remove web link 2/21/21
• Test Web Links 2/22/21

Webhooks

• Webhook (V2) payload Resource
• Webhook Resource
• Webhooks Resource
• Webhooks Collection
• List all webhooks
• Get webhook
• Create webhook
• Update webhook
• Remove webhook

Zip Downloads

• Zip download Resource
• Zip download status Resource
• Download zip archive
• Get zip download status
• Create zip download

Good Ideas

• [ ]