All notable changes to this project will be documented in this file. See standard-version for commit guidelines.
5.7.0 (2024-02-27)
- add marker-based pagination version of
GetFolderItems
(#936) (f877a8f) - Support sign request signer group ID (#938) (096a098)
5.6.1 (2023-11-29)
5.6.0 (2023-09-25)
5.5.0 (2023-09-20)
5.4.0 (2023-09-07)
5.3.0 (2023-09-04)
5.2.2 (2023-05-23)
5.2.1 (2023-04-18)
5.2.0 (2023-03-14)
- add
Id
toMetadataTemplateField
(#890) (b7fe214) - add
start_date_field
anddescription
to retention policies (#888) (100b722) - add configurable
JWTAudience
claim (#897) (50219fd) - add shared link support to
GetFolderItemsAsync
(#892) (0eba85c)
5.1.0 (2023-01-17)
5.0.0 (2023-01-12)
- upgrade .net framework to 4.6.2 (#881)
- remove deprecated methods (#881)
- remove
use_index
references (#881) - return proper object from
GetFileVersionsUnderRetentionForAssignmentAsync
(#881)
- upgrade .net framework to 4.6.2 (#881) (f1989aa), closes #863
- remove deprecated methods (#881) (f1989aa), closes #874
- remove
use_index
references (#881) (f1989aa), closes #870
- Added pagination option to
IBoxFilesManager#ViewVersionsAsync
(#869) (2324495), closes #866 - return proper object from
GetFileVersionsUnderRetentionForAssignmentAsync
(#881) (f1989aa), closes #875
4.6.0 (2022-10-18)
- Add
redirect_url
anddeclined_redirect_url
to Sign Request (#853) (5ef2f18) - Add support for modifiable retention policies & enable deleting retention policy assignment (#856) (564904f)
4.5.0 (2022-08-24)
- Add
content-type
field to sign request (#850) (054d3e1) - expose
effective_access
inBoxSharedLink
#843 (d84ddd4)
- fix null reference exception when it's not possible to get
runtime
version from the assembly (#851) (77046fb) - replace infinite retries with exponential backoff strategy in file representations (#835) (f2a5713)
4.4.0 (2022-06-14)
- add
can_edit
field toSharedLink
(#831) (e0d4197) - add
version_number
toBoxFileVersion
(#820) (f174358) - add upload and delete support for Avatar API (#829) (4dcb84a)
- Fix initialization of
BoxAPIException
object (#828) (a298f01) - properly dispose response on exception (#819) (8415bd3)
4.3.1 (2022-04-19)
4.3.0 (2022-04-01)
- add missing enum to string parsing in several places (#813) (e370282)
- properly cast response when uploading a new file version using session (#810) (73d877f)
4.2.0 (2022-02-10)
- correctly pass null when rolling out user from the enterprise (#792) (c85c573)
- Creating BoxAuthenticationFailedException no longer throws an exception (#790) (55a706e)
- Null Argument Exception in AutoPaginate (#666) (c61f08c)
- add admin_logs_streaming support (#797) (a775e1e)
- add Client Credentials Grant auth support (#799) (b8a64ca)
- add disposition_at field to the File object (#793) (2766a91)
- add possibility to set auth token uri in BoxConfig (#794) (ae8cd8b)
- deprecate index_name in ExecuteMetadataQuery (#800) (6a6a0e4)
4.1.0 (2021-12-14)
- add configurable Timeout for BoxClient (#779) (ac842ed)
- add file request api (#777) (1098f75)
- add vanity_name to SharedLink (#782) (00a1e26)
4.0.0 (2021-11-02)
- Extract interfaces for BoxClient and Managers to improve testability (#603)
- Add BoxConfigBuilder and make BoxConfig immutable (#737)
- Expose tasks from async methods (#742)
- Use DateTimeOffset instead of DateTime (#749)
- Rework returned exceptions (#753)
- Upgrade .NET Standard to 2.0 (#755)
- Add ability to get files under retention for assignment and file versions under retention for assignment (#734)
- Add
is_collaboration_restricted_to_enterprise
flag support forFolder
update (#732) - Replace insensitive language (#738)
- Add new, easier to use method for create terms of service user status (#740)
- Allow sort and direction parameter to be passed in when getting trashed items (#754)
- Add support for Task completion_rule field (#758)
- Add BoxSign API support (#765)
New Features and Enhancements:
- Add filter fields to get file version retentions (#717)
- Add support for search param to get shared link items (#721)
- Add folder lock functionality (#725)
New Features and Enhancements:
- Add support for filtering when getting Groups (#703)
- Add zip functionality (#700)
- Deprecate one of the overloaded
ExecuteMetadataQueryAsync()
methods (#699) - Add support for
copyInstanceOnItemCopy
field for metadata templates (#698)
Bug Fixes:
- Fix bug with JWT Authentication automatic retry (#697)
- Add path parameter sanitization
- Add support for the classification field for Files and Folders
- Fix bug with notification email field deserializing for
BoxUser
- Add
fields
parameter for metadata query - Add ability to set a request timeout for
FoldersManager.UpdateInformationAsync()
andUsersManager.MoverUserFolderAsync()
- Add ability to get and set a notification email address for a user
- Fix deadlock issue for JWT authentication in UI elements
- Add support for the uploader display name field for Files and File Versions
- Fixed Authentication Request Retries
- Added the ability to query Box items based on their metadata. The method to do so is
MetadataManager.ExecuteMetadataQueryAsync()
. - Added
TrashedAt
field toBoxItem
objects (file, folder, weblink). - Added marker based pagination for get users methods
- Updated retry logic to retry on 503 status codes returned by the API
- Provide better details for debugging, if the HttpClient used to make API requests times out
- Added
fields
parameter toUsersManager.GetUserInformationAsync()
- Added
ExternalAppUserId
property toBoxUser
model - Added the ability to set the
TrackingCodes
property when updating or creating a user (thanks @Cpcrook!)
- Added missing fields for File Version object.
- Added
FILE_VERSION_RESTORE
constant to Admin Event. - Added action_by field to Enterprise Event.
- Audited missing fields on BoxFile and BoxFolder objects.
- Better error handling and messaging for errors pertaining to OAuth2 error responses.
- Added
sort
anddirection
parameters toFoldersManager.GetFolderItemsAsync()
to enable sorting the folder items returned - Added a new
SearchManager.QueryAsync()
method with correct types for file size filter parameters - Deprecated the
SearchManager.SearchAsync()
method, which is superseded bySearchManager.QueryAsync()
- Added support for setting the
IsExternalCollabRestricted
parameter when creating and updating Users - Added a
WebProxy
property toBoxConfig
instances, which can be used to manually set the network proxy used by the SDK
- Fixed the encoding of dates in the query parameters for Events and Search endpoints
- Deprecated
FilesManager.DownloadStreamAsync()
and introduced a replacement method with correct parameter types for byte offsets:FilesManager.DownloadAsync()
- Added
sort
anddirection
parameters toclient.SearchManager.SearchAsync()
to control sort order - Added
extension
parameter toclient.FilesManager.GetThumbnailAsync()
to control which thumbnail format is returned (thanks @guilmori!) - Fixed a bug where query string parameters were not correctly encoded
- Added
SetFileMetadataAsync()
andSetFolderMetadataAsync()
methods toclient.MetadataManager
to set metadata keys and values, overwriting existing values for the provided keys. - Automatically retry most API calls when the API responds with a transient error status code
- Added support for passing custom IBoxService to BoxJWTAuth constructor.
- Removed unnecessary package.config from sample files.
- Added trace ID to API response exception message.
- Fix deserialization of translated task assignment status.
- Fixed an issue where some objects related to Events did not have their
.Id
property correctly deserialized from JSON
- Added the
.InviteEmail
property toBoxCollaboration
objects, which displays the email address for the invited user in a pending collaboration - Added
.Timezone
,.IsExternalCollabRestricted
,.Tags
, and.Hostname
properties toBoxUser
objects
- Added
client.FilesManager.GetCollaborationsCollectionAsync()
and deprecatedclient.FilesManager.GetCollaborationsAsync()
to enable paging through the entire collection of collaborations on a file - Added
client.WebLinksManager.CopyAsync()
,client.WebLinksManager.CreateSharedLinkAsync()
, andclient.WebLinksManager.DeleteSharedLinkAsync()
- Added
client.UsersManager.GetUserAvatarAsync()
for retrieving a user's avatar image
- Added support for reading and writing more Group fields
- Fixed an issue where the
UnsharedAt
field of a shared link could not be set tonull
- Fixed renaming a file on new version upload
- Added the ability to set the content modification timestamp on file version upload
- Fixed issues around reading the source of an event when the source item is a web link
- Added support for Metadata Cascade Policies
- Strong named the assembly.
- Added support for setting flag allowing non owners of a folder to invite collaborators.
- Fixed bug where Xamarin applications would run out of connections
- Added support for Storage Policies
- Fixed an issue where users could not create
BoxClient
on Xamarin - Added
File
property toBoxLock
objects in events - Added
MetadataManager.DeleteMetadataTemplate(string scope, string template)
for deleting a Metadata template - Made API URLs modifiable in
BoxConfig
- Improved API response error objects/messages
- Added support for assigning a Retention Policy to a metadata template
- Added
CONTENT_ACCESS
event type to enum
- Fixed an issue where a "Security protocol not supported" exception could be thrown on MacOS
- Added
client.FilesManager.GetRepresentationContentAsync()
for fetching a stream over representation contents - Fixed parsing of some
Source
objects onBoxEvent
objects
- Switched to exponential backoff when the SDK receives a rate limit or server error response.
- Force support for TLSv1.1 or higher when available to improve the security of connections to the Box API.
- Perform modified retry on JWT auth for when the local clock and the Box Server clock are not aligned as well as if the JWT ID has already been consumed.
- Made
name
parameter optional onRestoreTrashedAsync()
.
- Deprecated
uploadFileVersionUsingSessionAsync()
(which returned just a Box File Version) in favor ofuploadNewVersionUsingSessionAsync()
(which returns the entire Box File object containing the Box File Version). - Added support for OAuth2 access token creation type to the AdminEventTypesEnum
- Added
ExpiresAt
param toBoxCollaborationRequest
.
- Added support for Collaboration Whitelist endpoint
- Added Event Types Enum
- Fixed deserialization issue with BoxRepresentationStatus (#429)
- Added support for Terms of Service endpoint
- Added support for Metadata Template ID endpoint
- Added missing fields for Folder Model (#414)
- Added support for Representations endpoint
- Added support for Chunked Upload New File Version
- Fixed BoxEventsManager DateTime formatter (#400)
- Added Unified Metadata Support (#379)
- Major version bump to 3, targeting net45
- Upgrading the whole sln to vs2017
- Added support for Recents endpoint
- New operation on Metadata endpoint
- Progress on Chunked Upload New File
- Minor bug fixes