Package com.smartsheet.api.models
Model classes representing Smartsheet API objects.
This package contains the data model classes that represent the various objects in the Smartsheet API, including:
- Sheets, rows, columns, and cells
- Workspaces, folders, and reports
- Users, groups, and contacts
- Attachments, discussions, and comments
- Shares, webhooks, and automation rules
- And many other Smartsheet objects
These model classes are used for both request and response payloads when interacting with the Smartsheet API. They provide a strongly-typed interface for working with Smartsheet data.
-
Interface Summary Interface Description ObjectValue PrimitiveObjectValue<T> Recipient WidgetContent -
Class Summary Class Description AbstractRow<TColumn extends Column,TCell extends Cell> AbstractSheet<TRow extends AbstractRow<TColumn,TCell>,TColumn extends Column,TCell extends Cell> Account AlternateEmail The AlternateEmail object, retruned by endpoints like the Get Alternate Email endpointAlternateEmail.AddAlternateEmailBuilder A convenience class for making aAlternateEmailobject with the appropriate fields for adding to aUser.Attachment Represents the Attachment object.Attachment.CreateAttachmentBuilder A convenience class for quickly creating a List of cells to update.AutomationAction AutomationRule AutoNumberFormat Represents the AutoNumberFormat object.BooleanObjectValue BulkItemFailure BulkItemResult<T> BulkRowFailedItem Created by kskeem on 3/1/16.Cell Represents the Cell object that holds data in a sheet.Cell.AddRowCellsBuilder A convenience class for quickly creating a List of cells to add.Cell.UpdateRowCellsBuilder A convenience class for quickly creating a List of cells to update.CellDataItem CellHistory Represents CellHistory object.CellLink CellLinkWidgetContent ChartWidgetContent Column Represents the Column object.Column.AddColumnToSheetBuilder A convenience class to help create a column object with the appropriate fields for adding to a sheet.Column.UpdateColumnBuilder The Class UpdateColumnBuilder.Comment Represents the Comment object.Comment.AddCommentBuilder A convenience class to generate a comment with the appropriate fields for adding it to a sheet.Contact Represents the Contact object.ContactObjectValue ContainerDestination ContainerDestination.AddContainerDestinationBuilder A convenience class to generate a comment with the appropriate fields for adding it to a sheet.CopyOrMoveRowDestination CopyOrMoveRowDestination.InsertCopyOrMoveRowDestinationBuilder A convenience class for quickly creating a List of cells to update.CopyOrMoveRowDirective CopyOrMoveRowDirective.InsertCopyOrMoveRowDirectiveBuilder A convenience class to help create a CopyOrMoveRowDestination object with the appropriate fields for adding to a sheet.CopyOrMoveRowResult CreateShareRequest Represents a CreateShareRequest object in the Smartsheet API.CreateShareRequest.CreateShareRequestBuilder A convenience class for creating aCreateShareRequestwith the appropriate fields.Criteria CrossSheetReference Currency DateObjectValue DeleteUserParameters Discussion Represents the Discussion object.Discussion.CreateDiscussionBuilder A convenience class to help generate discussion object with the appropriate fields for adding a discussion to a sheet.Duration Email Represents an Email object.Error Represents Error object.ErrorDetail Event EventResult ExplicitNull Favorite Favorite.AddFavoriteBuilder FeatureInfo Folder Represents a folder.Folder.CreateFolderBuilder A convenience class for setting up a folder with the appropriate fields for updating the folder.Folder.UpdateFolderBuilder A convenience class for setting up a folder with the appropriate fields for updating the folder.FontFamily FormatDetails Represents the format details when generating a digital copy (PDF/EXCEL) of a sheet.FormatTables Group Represents a Group Object.Group.CreateGroupBuilder A convenience class to make aGroupobject with the necessary fields to create the group by posting it to smartsheet.Group.UpdateGroupBuilder A convenience class to update aGroupobject with the necessary fields to create the group by putting it to smartsheet.GroupMember Represents the Group Member object.GroupMember.AddGroupMemberBuilder A convenience class for making aGroupMemberobject with the appropriate fields for adding to aGroup.Home Represents the Home object.Hyperlink IdentifiableModel<T> Represents an object with an ID.IdentifiableModelMixin<T> This is a Jackson Mixin class that excludes "id" field from being serialized to JSON.Image ImageUrl ImageUrlMap Represents the ImageUrl object.ImageWidgetContent ListAssetSharesResponse<T> ListBuilder<T> Simple class that makes creating type safe lists of object easierMultiContactObjectValue MultiPicklistObjectValue MultiRowEmail Represents the multi row email object.MultiRowEmail.AddMultiRowEmailBuilder A convenience class to help create a MultiRowEmail object with the appropriate fields.NamedModel<T> Represents an object with a name and an id.NumberObjectValue PagedResult<T> A wrapper object used to Wrap the data that comes back from the API.PaginationParameters PaginationParameters.PaginationParametersBuilder A convenience class for creating a PaginationParameters objectPartialRowUpdateResult Created by kskeem on 3/1/16.Predecessor PredecessorList ProfileImage ProjectSettings RecipientEmail RecipientEmail.AddRecipientEmailBuilder A convenience class to help create a RecipientEmail object with the appropriate fields.RecipientGroup RecipientGroup.AddRecipientGroupBuilder A convenience class to help create a RecipientGroup object with the appropriate fields.Report A report object that is a filtered view of the data from one or more Sheets.ReportCell Represents the ReportCell object.ReportColumn Represents the “virtual” Column object for Report.ReportPublish The ReportPublish object.ReportRow Represents the ReportRow object.ReportWidgetContent Result<T> Result object to contain information about a PUT or POST request.Row Represents the Row object.Row.AddRowBuilder A convenience class for creating aRowWrapperwith the necessary fields for inserting aRowor set of rows.Row.UpdateRowBuilder RowEmail Represents RowEmail object.RowEmail.AddRowEmailBuilder A convenience class to help create a RowEmail object with the appropriate fields.RowMapping RowWrapper Represents the RowWrapper object that is used to specify the location for aRowor set of Rows.RowWrapper.InsertRowsBuilder A convenience class for creating aRowWrapperwith the necessary fields for inserting aRowor set of rows.RowWrapper.MoveRowBuilder A convenience class for creating aRowWrapperwith the necessary fields for moving aRowor set of rows.Schedule Scope SearchResult Represents the results of a search.SearchResultItem Represents one specific result of a search.SelectionRange SentUpdateRequest ServerInfo Share Represents a Share Object.Share.CreateGroupShareBuilder A convenience class for creating aSharewith the necessary fields to create aShareType.GROUPShare.Share.CreateUserShareBuilder A convenience class for creating aSharewith the necessary fields to create aShareType.USERShare.Share.ShareToOneGroupBuilder Share.ShareToOneUserBuilder A convenience class for creating aSharewith the necessary fields for sharing the sheet to one user.Share.UpdateShareBuilder A convenience class for creating aSharewith the necessary fields to update a specific share.ShareResponse Represents a ShareResponse object in the Smartsheet API.Sheet Represents the Sheet object.Sheet.CreateFromTemplateOrSheetBuilder A class to simplify the creation of a sheet from another sheet or another template.Sheet.CreateSheetBuilder A convenience class to make aSheetobject with the necessary fields to create the sheet by posting it to smartsheet.Sheet.UpdateSheetBuilder The Class UpdateSheetBuilder.SheetEmail Represents Sheet Email object used for sending a sheet by email.SheetEmail.AddSheetEmailBuilder A convenience class to help create a SheetEmail object with the appropriate fields.SheetFilter SheetFilterDetails SheetPublish Represents the publish status of a sheet.SheetPublish.PublishStatusBuilder A convenience class for making aSheetPublishobject with the necessary fields to publish a sheet.SheetSummary SheetUserPermissions SheetUserSettings SheetUserSettings.AddUserSettingsBuilder The Class AddUserSettingsBuilder.ShortcutDataItem ShortcutWidgetContent Sight SightPublish SortCriterion SortSpecifier Source StringObjectValue SummaryField Template A template object that is a default layout for future sheets.TitleRichTextWidgetContent TokenPaginatedResult<T> Represents a generic token-based paginated result that can contain any type of data.UpdateRequest Represents the UpdateRequest object.UpdateShareRequest Represents an UpdateShareRequest object in the Smartsheet API.UpdateShareRequest.UpdateShareRequestBuilder A convenience class for creating anUpdateShareRequestwith the appropriate fields.User Represents the User object.User.AddUserBuilder A convenience class for making aUserobject with the appropriate fields for adding the user.User.NewGroupMemberBuilder A convenience class for making a GroupMember object with the appropriate fields for adding to aGroup.User.UpdateUserBuilder A convenience class for making aUserobject with the appropriate fields for updating a user.UserModel UserModelWithName Represents the User Model object with name.UserPlan Represents the UserPlan object.UserProfile A profile object that contains the basic fields that most profiles will contain.WebContentWidgetContent Webhook WebhookSharedSecret WebhookStats WebhookSubscope Widget WidgetHyperlink Workspace Represents the Workspace object which is an area in which sheets, reports, templates and sub-folders can be organized, similar to a folder.Workspace.UpdateWorkspaceBuilder A convenience class for creating aWorkspaceobject with the appropriate fields for updating a workspace.