search

smartsheet / smartsheet-java-sdk

Library that uses Java to connect to Smartsheet services.
Apache License 2.0
3 stars 12 forks source link

Add Deprecation advice and mark methods for removal #68

Closed zromano closed 12 months ago

zromano commented 1 year ago

Adds a deprecated since tag to all our deprecated methods and adds advice on what method the user should migrate to. Also marks all the methods for removal, so people know that we will be removing them in our next major release.

Things I would like a second pair of eyes on:

It looks like the RowResources interface is never used?

Methods it was unclear on why they were deprecated:

# Method Path Forward
1 FolderResources::copyFolder((long folderId, ContainerDestination containerDestination, EnumSet<FolderCopyInclusion> includes, EnumSet<FolderRemapExclusion> skipRemap, EnumSet<CopyExclusion> excludes) I don't think this should be deprecated. It was deprecated for the excludes, but it's still listed in the public api docs.
2 ShareResources::listShares(long objectId, PaginationParameters parameters) This is a helper that automatically doesn't include workspace shares. It saves the client from having to decide to include them or not. I think this can be deprecated because they can just call it with the boolean.
3 ReportResources::listReports(PaginationParameters parameters) I don't think this needs to be deprecated. It's just a helper for not providing a modified since date.
4 SheetResources::listSheets(EnumSet<SourceInclusion> includes, PaginationParameters pagination) I don't think this needs to be deprecated. It's just a helper for not providing a modified since date.
5 UserResources::listOrgSheets(PaginationParameters pagination) I don't think this needs to be deprecated. It's just a helper for not providing a modified since date.