Table of Contents

Namespace Smartsheet.Api

Classes

AccessTokenExpiredException

This is the exception to indicate that an access token expired error returned from Smartsheet REST API. This exception will be thrown when the Smartsheet REST API generates a "1003 Your Access Token has expired" error.

Thread safety: Exceptions are not thread safe.

AuthorizationException

This is the exception to indicate authorization (access token) related errors returned from Smartsheet REST API.

Basically this exception will be thrown when the Smartsheet REST API responds with "401 NOT AUTHORIZED" / "403 FORBIDDEN"

Thread safety: Exceptions are not thread safe.

InvalidRequestException

This is the exception to indicate invalid request error returned from Smartsheet REST API.

Basically this exception will be thrown when the Smartsheet REST API responds with "400 BAD REQUEST".

Thread safety: Exceptions are not thread safe.

ResourceNotFoundException

This is the exception to indicate a resource can not be found.

Basically this exception will be thrown when the Smartsheet REST API responds with "404 NOT FOUND".

Thread safety: Exceptions are not thread safe.

ServiceUnavailableException

This is the exception to indicate a service unavailable error (possibly due to rate limiting) returned from the Smartsheet REST API.

Basically this exception will be thrown when the Smartsheet REST API responds with "503 SERVICE UNAVAILABLE".

Thread safety: Exceptions are not thread safe.

SmartsheetBuilder

A convenience class to help create a SmartsheetClient instance with the appropriate fields.

Thread Safety: This class is not thread safe since it's mutable, one builder instance is NOT expected to be used in multiple threads.

SmartsheetException

This is the base class for all exceptions thrown from the Smartsheet SDK.

Thread safety: Exceptions are not thread safe.

SmartsheetRestException

This is the exception to indicate errors (Error objects of Smartsheet REST API) returned from Smartsheet REST API.

Thread safety: Exceptions are not thread safe.

Interfaces

AttachmentVersioningResources

This interface provides methods to access Versioning resources that are associated to an Attachment resource.

Thread Safety: Implementation of this interface must be thread safe.

CommentAttachmentResources

This interface provides methods to access Attachment resources that are associated to Comment resources.

Thread Safety: Implementation of this interface must be thread safe.

ContactResources

This interface provides methods to access Contact resources.

Thread Safety: Implementation of this interface must be thread safe.

DiscussionAttachmentResources

This interface provides methods to access Attachment resources that are associated to Discussion resources.

Thread Safety: Implementation of this interface must be thread safe.

DiscussionCommentResources

This interface provides methods to access Comment resources.

Thread Safety: Implementation of this interface must be thread safe.

EventResources

Interface for event resources

FavoriteResources

This interface provides methods to access Favorite resources.

Thread Safety: Implementation of this interface must be thread safe.

FolderResources

This interface provides methods to access Folder resources.

Thread Safety: Implementation of this interface must be thread safe.

FolderSheetResources

This interface provides methods to access sheet resources that are associated to a Folder object.

Thread Safety: Implementation of this interface must be thread safe.

GroupResources

This interface provides methods to access Group resources.

Thread Safety: Implementation of this interface must be thread safe.

HomeFolderResources

This interface provides methods to access Folder resources under home.

Thread Safety: Implementation of this interface must be thread safe.

HomeResources

This interface provides methods to access resources previously from the deprecated home API.

Thread Safety: Implementation of this interface must be thread safe.

ImageUrlsResources

This interface provides methods to access image URLs.

Thread Safety: Implementation of this interface must be thread safe.

PassthroughResources

Interface used to encapsulate resources that are just pass throughs to more implmentation specific uses.

ReportResources

This interface provides methods to access Report resources.

Thread Safety: Implementation of this interface must be thread safe.

RowAttachmentResources

This interface provides methods to access Attachment resources associated to a row resource.

Thread Safety: Implementation of this interface must be thread safe.

RowColumnResources

This interface provides methods to access cell resources that are associated to a row and column.

Thread Safety: Implementation of this interface must be thread safe.

RowDiscussionResources

This interface provides methods to access Discussion resources associated to a row resource.

Thread Safety: Implementation of this interface must be thread safe.

SearchResources

This interface provides methods to access search resources.

Thread Safety: Implementation of this interface must be thread safe.

ServerInfoResources

This interface provides methods to access Sheet resources.

Thread Safety: Implementation of this interface must be thread safe.

ShareResources

This interface provides methods to access Share resources.

Thread Safety: Implementation of this interface must be thread safe.

SheetAttachmentResources

This interface provides methods to access Attachment resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

SheetAutomationRuleResources

This interface provides methods to access AutomationRule resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

SheetColumnResources

This interface provides methods to access column resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

SheetCommentResources

This interface provides methods to access Comment resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

SheetCrossSheetReferenceResources

Interface used to encapsulate sheet cross sheet reference resources.

SheetDiscussionResources

This interface provides methods to access discussion resources that are associated to a Sheet object.

Thread Safety: Implementation of this interface must be thread safe.

SheetFilterResources

This interface provides methods to access sheet filter resources.

Thread Safety: Implementation of this interface must be thread safe.

SheetResources

This interface provides methods to access sheet resources.

Thread Safety: Implementation of this interface must be thread safe.

SheetRowResources

This interface provides methods to access row resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

SheetSummaryResources

This interface provides methods to access sheet summary resources that are associated to a sheet object.

Thread Safety: Implementation of this interface must be thread safe.

SheetUpdateRequestResources

Interface used to encapsulate sheet update request resources.

SightResources

Interface used to encapsulate sight/dashboard resources.

SmartsheetClient

This interface is the entry point of the Smartsheet SDK, it provides convenient methods to get XXXResources instances for accessing different types of resources.

Thread Safety: Implementation of this interface must be thread safe.

TemplateResources

This interface provides methods to access Template resources.

Thread Safety: Implementation of this interface must be thread safe.

TokenResources

This interface provides methods to access Token resources.

Thread Safety: Implementation of this interface must be thread safe.

UserResources

This interface provides methods to access User resources.

Thread Safety: Implementation of this interface must be thread safe.

UserSheetResources

This interface provides methods to access Sheet resources of User.

Thread Safety: Implementation of this interface must be thread safe.

WebhookResources

Interface used to encapsulate webhook resources.

WorkspaceFolderResources

This interface provides methods to access Folder resources that are associated to a workspace object.

Thread Safety: Implementation of this interface must be thread safe.

WorkspaceResources

This interface provides methods to access Workspace resources.

Thread Safety: Implementation of this interface must be thread safe.

WorkspaceSheetResources

This interface provides methods to access sheet resources that are associated to a Workspace object.

Thread Safety: Implementation of this interface must be thread safe.