
com.smartsheet.api.FavoriteResources Maven / Gradle / Ivy
Show all versions of smartsheet-sdk-java Show documentation
/*
* Copyright (C) 2024 Smartsheet
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.smartsheet.api;
import com.smartsheet.api.models.Favorite;
import com.smartsheet.api.models.PagedResult;
import com.smartsheet.api.models.PaginationParameters;
import com.smartsheet.api.models.enums.FavoriteType;
import java.util.List;
import java.util.Set;
public interface FavoriteResources {
/**
* Adds one or more items to the user’s list of Favorite items.
*
* It mirrors to the following Smartsheet REST API method: POST /favorites
*
* Exceptions:
* IllegalArgumentException : if any argument is null
* InvalidRequestException : if there is any problem with the REST API request
* AuthorizationException : if there is any problem with the REST API authorization(access token)
* ResourceNotFoundException : if the resource can not be found
* ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting)
* SmartsheetRestException : if there is any other REST API related error occurred during the operation
* SmartsheetException : if there is any other error occurred during the operation
*
* @param favorites the list of favorites object limited to the following attributes: * objectId * type
* @return a single Favorite object or an array of Favorite objects
* @throws SmartsheetException the smartsheet exception
*/
List addFavorites(List favorites) throws SmartsheetException;
/**
* Gets a list of all of the user’s Favorite items.
*
* It mirrors to the following Smartsheet REST API method: GET /favorites
*
* Exceptions:
* IllegalArgumentException : if any argument is null
* InvalidRequestException : if there is any problem with the REST API request
* AuthorizationException : if there is any problem with the REST API authorization(access token)
* ResourceNotFoundException : if the resource can not be found
* ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting)
* SmartsheetRestException : if there is any other REST API related error occurred during the operation
* SmartsheetException : if there is any other error occurred during the operation
*
* @param parameters pagination parameters
* @return a single Favorite object or an array of Favorite objects
* @throws SmartsheetException the smartsheet exception
*/
PagedResult listFavorites(PaginationParameters parameters) throws SmartsheetException;
/**
* Gets a single Favorite item by type and objectId. If the object is not a favorite, a 404 status will be returned.
*
* It mirrors to the following Smartsheet REST API method: GET /favorites/{favoriteType}/{objectId}
*
* Exceptions:
* IllegalArgumentException : if any argument is null
* InvalidRequestException : if there is any problem with the REST API request
* AuthorizationException : if there is any problem with the REST API authorization(access token)
* ResourceNotFoundException : if the resource can not be found or the object is not a favorite
* ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting)
* SmartsheetRestException : if there is any other REST API related error occurred during the operation
* SmartsheetException : if there is any other error occurred during the operation
*
* @param favoriteType the favoriteType
* @param objectId a single favorite objectId
* @return a single Favorite object
* @throws SmartsheetException the smartsheet exception
*/
Favorite isFavorite(FavoriteType favoriteType, Long objectId) throws SmartsheetException;
/**
* Deletes a list of favorites (all of the same type)
*
* It mirrors to the following Smartsheet REST API method: DELETE /favorites
*
* Exceptions:
* IllegalArgumentException : if any argument is null
* InvalidRequestException : if there is any problem with the REST API request
* AuthorizationException : if there is any problem with the REST API authorization(access token)
* ResourceNotFoundException : if the resource can not be found
* ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting)
* SmartsheetRestException : if there is any other REST API related error occurred during the operation
* SmartsheetException : if there is any other error occurred during the operation
*
* @param favoriteType the favorite type
* @param objectIds a single Favorite object ID or an array of Favorite object IDs
* @throws SmartsheetException the smartsheet exception
*/
void removeFavorites(FavoriteType favoriteType, Set objectIds) throws SmartsheetException;
}