com.smartsheet.api.SightResources Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation
Library for connecting to Smartsheet Services
There is a newer version: 3.2.0
/*
 * #[license]
 * Smartsheet SDK for Java
 * %%
 * Copyright (C) 2014 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.
 * %[license]
 */

package com.smartsheet.api;

import com.smartsheet.api.models.ContainerDestination;
import com.smartsheet.api.models.PagedResult;
import com.smartsheet.api.models.PaginationParameters;
import com.smartsheet.api.models.Sight;

import java.util.Date;

public interface SightResources {

	/**
	 * Gets the list of all Sights where the User has access.
	 * 
	 * It mirrors to the following Smartsheet REST API method: GET /sights
	 *
	 * @param paging the pagination parameters
	 * @param modifiedSince include sights modified on or after this date
	 * @return IndexResult object containing an array of Sight objects limited to the following attributes:
	 * 	id, name, accessLevel, permalink, createdAt, modifiedAt.
	 * @throws IllegalArgumentException if any argument is null or empty string
	 * @throws InvalidRequestException if there is any problem with the REST API request
	 * @throws AuthorizationException if there is any problem with  the REST API authorization (access token)
	 * @throws ResourceNotFoundException if the resource cannot be found
	 * @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
	 * @throws SmartsheetException if there is any other error during the operation
	 */
	public PagedResult listSights(PaginationParameters paging, Date modifiedSince) throws SmartsheetException;

	/**
	 * Get a specified Sight.
	 * 
	 * It mirrors to the following Smartsheet REST API method: GET /sights/{sightId}
	 *
	 * @param sightId the Id of the Sight
	 * @return the Sight resource.
	 * @throws IllegalArgumentException if any argument is null or empty string
	 * @throws InvalidRequestException if there is any problem with the REST API request
	 * @throws AuthorizationException if there is any problem with  the REST API authorization (access token)
	 * @throws ResourceNotFoundException if the resource cannot be found
	 * @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
	 * @throws SmartsheetException if there is any other error during the operation
	 */
	public Sight getSight(long sightId) throws SmartsheetException;
	
	/**
	 * Get a specified Sight.
	 * 
	 * It mirrors to the following Smartsheet REST API method: PUT /sights/{sightId}
	 *
	 * @param sight - the Sight to update
	 * @return the updated Sight resource.
	 * @throws IllegalArgumentException if any argument is null or empty string
	 * @throws InvalidRequestException if there is any problem with the REST API request
	 * @throws AuthorizationException if there is any problem with  the REST API authorization (access token)
	 * @throws ResourceNotFoundException if the resource cannot be found
	 * @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
	 * @throws SmartsheetException if there is any other error during the operation
	 */
	public Sight updateSight(Sight sight) throws SmartsheetException;
	
	/**
	 * Delete a specified Sight.
	 * 
	 * It mirrors to the following Smartsheet REST API method: DELETE /sights/{sightId}
	 *
	 * @param sightId the Id of the Sight
	 * @throws IllegalArgumentException if any argument is null or empty string
	 * @throws InvalidRequestException if there is any problem with the REST API request
	 * @throws AuthorizationException if there is any problem with  the REST API authorization (access token)
	 * @throws ResourceNotFoundException if the resource cannot be found
	 * @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
	 * @throws SmartsheetException if there is any other error during the operation
	 */
	public void deleteSight(long sightId) throws SmartsheetException;
	
	/**
	 * Creates s copy of the specified Sight.
	 * 
	 * It mirrors to the following Smartsheet REST API method: POST /sights/{sightId}/copy
	 *
	 * @param sightId the Id of the Sight
	 * @param destination the destination to copy to
	 * @return the newly created Sight resource.
	 * @throws IllegalArgumentException if any argument is null or empty string
	 * @throws InvalidRequestException if there is any problem with the REST API request
	 * @throws AuthorizationException if there is any problem with  the REST API authorization (access token)
	 * @throws ResourceNotFoundException if the resource cannot be found
	 * @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
	 * @throws SmartsheetException if there is any other error during the operation
	 */	
	public Sight copySight(long sightId, ContainerDestination destination) throws SmartsheetException;
	
	/**
	 * Creates s copy of the specified Sight.
	 * 
	 * It mirrors to the following Smartsheet REST API method: POST /sights/{sightId}/move
	 *
	 * @param sightId the Id of the Sight
	 * @param destination the destination to copy to
	 * @return the newly created Sight resource.
	 * @throws IllegalArgumentException if any argument is null or empty string
	 * @throws InvalidRequestException if there is any problem with the REST API request
	 * @throws AuthorizationException if there is any problem with  the REST API authorization (access token)
	 * @throws ResourceNotFoundException if the resource cannot be found
	 * @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
	 * @throws SmartsheetException if there is any other error during the operation
	 */	
	public Sight moveSight(long sightId, ContainerDestination destination) throws SmartsheetException;
	
	/**
	 * Return the ShareResources object that provides access to share resources associated with
	 * Sight resources.
	 *
	 * @return the associated share resources
	 */	
	public ShareResources shareResources();
}