smartsheet.models package

Submodules

smartsheet.models.access_token module

class smartsheet.models.access_token.AccessToken(props=None, base_obj=None)

Bases: object

Smartsheet AccessToken data model.

access_token
expires_at
expires_in
refresh_token
to_dict()
to_json()
token_type

smartsheet.models.account module

class smartsheet.models.account.Account(props=None, base_obj=None)

Bases: object

Smartsheet Account data model.

id_
name
to_dict()
to_json()

smartsheet.models.alternate_email module

class smartsheet.models.alternate_email.AlternateEmail(props=None, base_obj=None)

Bases: object

Smartsheet AlternateEmail data model.

confirmed
email
id_
to_dict()
to_json()

smartsheet.models.attachment module

class smartsheet.models.attachment.Attachment(props=None, base_obj=None)

Bases: object

Smartsheet Attachment data model.

attachment_sub_type
attachment_type
created_at
created_by
id_
mime_type
name
parent_id
parent_type
size_in_kb
to_dict()
to_json()
url
url_expires_in_millis

smartsheet.models.auto_number_format module

class smartsheet.models.auto_number_format.AutoNumberFormat(props=None, base_obj=None)

Bases: object

Smartsheet AutoNumberFormat data model.

fill
prefix
starting_number
suffix
to_dict()
to_json()

smartsheet.models.boolean_object_value module

class smartsheet.models.boolean_object_value.BooleanObjectValue(value=None, base_obj=None)

Bases: smartsheet.models.primitive_object_value.PrimitiveObjectValue

Smartsheet BooleanObjectValue data model.

object_type

smartsheet.models.bulk_item_failure module

class smartsheet.models.bulk_item_failure.BulkItemFailure(props=None, dynamic_result_type=None, base_obj=None)

Bases: object

Smartsheet BulkItemFailure data model.

error
index
row_id
to_dict()
to_json()

smartsheet.models.bulk_item_result module

class smartsheet.models.bulk_item_result.BulkItemResult(props=None, dynamic_result_type=None, base_obj=None)

Bases: object

Smartsheet BulkItemResult data model.

data

Simplify difference between Result and IndexResult

failed_items
message
result
result_code
to_dict()
to_json()
version

smartsheet.models.cell module

class smartsheet.models.cell.Cell(props=None, base_obj=None)

Bases: object

Smartsheet Cell data model.

column_id
column_type
conditional_format
display_value
format_
formula
image
object_value
override_validation
strict
to_dict()
to_json()
value

smartsheet.models.cell_data_item module

class smartsheet.models.cell_data_item.CellDataItem(props=None, base_obj=None)

Bases: object

Smartsheet CellDataItem data model.

cell
column_id
label
label_format
object_value
order
to_dict()
to_json()
value_format

smartsheet.models.cell_history module

class smartsheet.models.cell_history.CellHistory(props=None, base_obj=None)

Bases: smartsheet.models.cell.Cell

Smartsheet CellHistory data model.

modified_at
modified_by
to_dict()
to_json()

smartsheet.models.column module

class smartsheet.models.column.Column(props=None, base_obj=None)

Bases: object

Smartsheet Column data model.

auto_number_format
contact_options
format_
hidden
id_
index
locked
locked_for_user
options
primary
symbol
system_column_type
tags
title
to_dict()
to_json()
type_
validation
width

smartsheet.models.comment module

class smartsheet.models.comment.Comment(props=None, base_obj=None)

Bases: object

Smartsheet Comment data model.

attachments
created_at
created_by
discussion_id
id_
modified_at
text
to_dict()
to_json()

smartsheet.models.contact module

class smartsheet.models.contact.Contact(props=None, base_obj=None)

Bases: object

Smartsheet Contact data model.

email
id_
name
to_dict()
to_json()

smartsheet.models.contact_object_value module

class smartsheet.models.contact_object_value.ContactObjectValue(props=None, base_obj=None)

Bases: smartsheet.models.object_value.ObjectValue, smartsheet.models.contact.Contact

Smartsheet ContactObjectValue data model.

smartsheet.models.contact_option module

class smartsheet.models.contact_option.ContactOption(props=None, base_obj=None)

Bases: object

Smartsheet ContactOption data model.

email
name
to_dict()
to_json()

smartsheet.models.container_destination module

class smartsheet.models.container_destination.ContainerDestination(props=None, base_obj=None)

Bases: object

Smartsheet ContainerDestination data model.

destination_id
destination_type
new_name
to_dict()
to_json()

smartsheet.models.copy_or_move_row_destination module

class smartsheet.models.copy_or_move_row_destination.CopyOrMoveRowDestination(props=None, base_obj=None)

Bases: object

Smartsheet CopyOrMoveRowDestination data model.

sheet_id
to_dict()
to_json()

smartsheet.models.copy_or_move_row_directive module

class smartsheet.models.copy_or_move_row_directive.CopyOrMoveRowDirective(props=None, base_obj=None)

Bases: object

Smartsheet CopyOrMoveRowDirective data model.

row_ids
to
to_dict()
to_json()

smartsheet.models.copy_or_move_row_result module

class smartsheet.models.copy_or_move_row_result.CopyOrMoveRowResult(props=None, base_obj=None)

Bases: object

Smartsheet CopyOrMoveRowResult data model.

destination_sheet_id
row_mappings
to_dict()
to_json()

smartsheet.models.criteria module

class smartsheet.models.criteria.Criteria(props=None, base_obj=None)

Bases: object

Smartsheet Criteria data model.

column_id
operator
to_dict()
to_json()
values

smartsheet.models.currency module

class smartsheet.models.currency.Currency(props=None, base_obj=None)

Bases: object

Smartsheet Currency data model.

code
symbol
to_dict()
to_json()

smartsheet.models.date_object_value module

class smartsheet.models.date_object_value.DateObjectValue(props=None, object_type=None, base_obj=None)

Bases: smartsheet.models.object_value.ObjectValue

Smartsheet DateObjectValue data model.

value

smartsheet.models.discussion module

class smartsheet.models.discussion.Discussion(props=None, base_obj=None)

Bases: object

Smartsheet Discussion data model.

access_level
comment
comment_attachments
comment_count
comments
created_by
id_
last_commented_at
last_commented_user
parent_id
parent_type
read_only
title
to_dict()
to_json()

smartsheet.models.downloaded_file module

class smartsheet.models.downloaded_file.DownloadedFile(props=None, base_obj=None)

Bases: object

Smartsheet DownloadedFile data model.

download_directory
filename
message
resp
result_code
save_to_file(chunksize=65536)
to_dict()
to_json()

smartsheet.models.duration module

class smartsheet.models.duration.Duration(props=None, base_obj=None)

Bases: smartsheet.models.object_value.ObjectValue

Smartsheet Duration data model.

days
elapsed
hours
milliseconds
minutes
negative
seconds
weeks

smartsheet.models.email module

class smartsheet.models.email.Email(props=None, base_obj=None)

Bases: object

Smartsheet Email data model.

cc_me
message
send_to
subject
to_dict()
to_json()

smartsheet.models.error module

class smartsheet.models.error.Error(props=None, base_obj=None)

Bases: object

Smartsheet Error data model.

request_response
result
to_dict()
to_json()

smartsheet.models.error_result module

class smartsheet.models.error_result.ErrorResult(props=None, base_obj=None)

Bases: object

Smartsheet ErrorResult data model.

code
error_code
message
name
recommendation
ref_id
should_retry
status_code
to_dict()
to_json()

smartsheet.models.explicit_null module

class smartsheet.models.explicit_null.ExplicitNull

Bases: object

is_explicit_null()

smartsheet.models.favorite module

class smartsheet.models.favorite.Favorite(props=None, base_obj=None)

Bases: object

Smartsheet Favorite data model.

object_id
to_dict()
to_json()
type_

smartsheet.models.folder module

class smartsheet.models.folder.Folder(props=None, base_obj=None)

Bases: object

Smartsheet Folder data model.

create_folder(folder_obj)
favorite
folders
id_
name
reports
sheets
sights
templates
to_dict()
to_json()

smartsheet.models.font_family module

class smartsheet.models.font_family.FontFamily(props=None, base_obj=None)

Bases: object

Smartsheet FontFamily data model.

name
to_dict()
to_json()
traits

smartsheet.models.format_details module

class smartsheet.models.format_details.FormatDetails(props=None, base_obj=None)

Bases: object

Smartsheet FormatDetails data model.

paper_size
to_dict()
to_json()

smartsheet.models.format_tables module

class smartsheet.models.format_tables.FormatTables(props=None, base_obj=None)

Bases: object

Smartsheet FormatTables data model.

bold
color
currency
decimal_count
defaults
font_family
font_size
horizontal_align
italic
number_format
strikethrough
text_wrap
thousands_separator
to_dict()
to_json()
underline
vertical_align

smartsheet.models.group module

class smartsheet.models.group.Group(props=None, base_obj=None)

Bases: object

Smartsheet Group data model.

created_at
description
id_
members
modified_at
name
owner
owner_id
to_dict()
to_json()

smartsheet.models.group_member module

class smartsheet.models.group_member.GroupMember(props=None, base_obj=None)

Bases: object

Smartsheet GroupMember data model.

email
first_name
id_
last_name
name
to_dict()
to_json()

smartsheet.models.home module

class smartsheet.models.home.Home(props=None, base_obj=None)

Bases: object

Smartsheet Home data model.

folders
reports
sheets
sights
templates
to_dict()
to_json()
workspaces

smartsheet.models.image module

class smartsheet.models.image.Image(props=None, base_obj=None)

Bases: object

Smartsheet Image data model.

alt_text
height
id_
to_dict()
to_json()
width

smartsheet.models.image_url module

class smartsheet.models.image_url.ImageUrl(props=None, base_obj=None)

Bases: object

Smartsheet ImageUrl data model.

error
height
image_id
to_dict()
to_json()
url
width

smartsheet.models.image_url_map module

class smartsheet.models.image_url_map.ImageUrlMap(props=None, base_obj=None)

Bases: object

Smartsheet ImageUrlMap data model.

image_urls
to_dict()
to_json()
url_expires_in_millis

smartsheet.models.index_result module

class smartsheet.models.index_result.IndexResult(props=None, dynamic_data_type=None, base_obj=None)

Bases: object

Smartsheet IndexResult data model.

data
page_number
page_size
result

Simplify difference between Result and IndexResult

to_dict()
to_json()
total_count
total_pages

smartsheet.models.json_object module

class smartsheet.models.json_object.JSONObject(payload=None, base_obj=None)

Bases: object

Smartsheet JSONObject data model.

data
serialize()
to_dict()
to_json()

smartsheet.models.multi_row_email module

class smartsheet.models.multi_row_email.MultiRowEmail(props=None, base_obj=None)

Bases: smartsheet.models.row_email.RowEmail

Smartsheet MultiRowEmail data model.

row_ids
to_dict()
to_json()

smartsheet.models.number_object_value module

class smartsheet.models.number_object_value.NumberObjectValue(value=None, base_obj=None)

Bases: smartsheet.models.primitive_object_value.PrimitiveObjectValue

Smartsheet NumberObjectValue data model.

object_type

smartsheet.models.o_auth_error module

class smartsheet.models.o_auth_error.OAuthError(props=None, base_obj=None)

Bases: object

Smartsheet OAuthError data model.

error
error_code
error_description
to_dict()
to_json()

smartsheet.models.object_value module

class smartsheet.models.object_value.ObjectValue(object_type=None, base_obj=None)

Bases: object

Smartsheet ObjectValue data model.

object_type
serialize()
to_dict()
to_json()
smartsheet.models.object_value.enum_object_value_type(object_type=None)

smartsheet.models.predecessor module

class smartsheet.models.predecessor.Predecessor(props=None, base_obj=None)

Bases: object

Smartsheet Predecessor data model.

in_critical_path
invalid
lag
row_id
row_number
to_dict()
to_json()
type

smartsheet.models.predecessor_list module

class smartsheet.models.predecessor_list.PredecessorList(props=None, base_obj=None)

Bases: smartsheet.models.object_value.ObjectValue

Smartsheet PredecessorList data model.

predecessors

smartsheet.models.primitive_object_value module

class smartsheet.models.primitive_object_value.PrimitiveObjectValue(value=None, base_obj=None)

Bases: object

Smartsheet PrimitiveObjectValue data model.

serialize()
to_dict()
to_json()
value

smartsheet.models.project_settings module

class smartsheet.models.project_settings.ProjectSettings(props=None, base_obj=None)

Bases: object

Smartsheet ProjectSettings data model.

length_of_day
non_working_days
to_dict()
to_json()
working_days

smartsheet.models.recipient module

class smartsheet.models.recipient.Recipient(props=None, base_obj=None)

Bases: object

Smartsheet Recipient data model.

email
group_id
to_dict()
to_json()

smartsheet.models.report module

class smartsheet.models.report.Report(props=None, base_obj=None)

Bases: smartsheet.models.sheet.Sheet

Smartsheet Report data model.

columns
rows
source_sheets
to_dict()
to_json()

smartsheet.models.report_cell module

class smartsheet.models.report_cell.ReportCell(props=None, base_obj=None)

Bases: smartsheet.models.cell.Cell

Smartsheet ReportCell data model.

to_dict()
to_json()
virtual_column_id

smartsheet.models.report_column module

class smartsheet.models.report_column.ReportColumn(props=None, base_obj=None)

Bases: smartsheet.models.column.Column

Smartsheet ReportColumn data model.

sheet_name_column
to_dict()
to_json()
virtual_id

smartsheet.models.report_publish module

class smartsheet.models.report_publish.ReportPublish(props=None, base_obj=None)

Bases: object

Smartsheet ReportPublish data model.

read_only_full_accessible_by
read_only_full_default_view
read_only_full_enabled
read_only_full_show_toolbar
read_only_full_url
to_dict()
to_json()

smartsheet.models.report_row module

class smartsheet.models.report_row.ReportRow(props=None, base_obj=None)

Bases: smartsheet.models.row.Row

Smartsheet ReportRow data model.

cells
sheet_id
to_dict()
to_json()

smartsheet.models.result module

class smartsheet.models.result.Result(props=None, dynamic_result_type=None, base_obj=None)

Bases: object

Smartsheet Result data model.

data

Simplify difference between Result and IndexResult

message
result
result_code
to_dict()
to_json()
version

smartsheet.models.row module

class smartsheet.models.row.Row(props=None, base_obj=None)

Bases: object

Smartsheet Row data model.

above
access_level
attachments
cells
columns
conditional_format
created_at
created_by
discussions
expanded
filtered_out
format_
get_column(column_id)
id_
in_critical_path
indent
locked
locked_for_user
modified_at
modified_by
outdent
parent_id
row_number
set_column(column_id, replacement_cell)
sheet_id
sibling_id
to_bottom
to_dict()
to_json()
to_top
version

smartsheet.models.row_email module

class smartsheet.models.row_email.RowEmail(props=None, base_obj=None)

Bases: smartsheet.models.email.Email

Smartsheet RowEmail data model.

column_ids
include_attachments
include_discussions
layout
to_dict()
to_json()

smartsheet.models.row_mapping module

class smartsheet.models.row_mapping.RowMapping(props=None, base_obj=None)

Bases: object

Smartsheet RowMapping data model.

from_
to
to_dict()
to_json()

smartsheet.models.schedule module

class smartsheet.models.schedule.Schedule(props=None, base_obj=None)

Bases: object

Smartsheet Schedule data model.

day_descriptors
day_of_month
day_ordinal
end_at
last_sent_at
next_send_at
repeat_every
start_at
to_dict()
to_json()
type_

smartsheet.models.search_result module

class smartsheet.models.search_result.SearchResult(props=None, base_obj=None)

Bases: object

Smartsheet SearchResult data model.

results
to_dict()
to_json()
total_count

smartsheet.models.search_result_item module

class smartsheet.models.search_result_item.SearchResultItem(props=None, base_obj=None)

Bases: object

Smartsheet SearchResultItem data model.

context_data
favorite
object_id
object_type
parent_object_favorite
parent_object_id
parent_object_name
parent_object_type
text
to_dict()
to_json()

smartsheet.models.sent_update_request module

class smartsheet.models.sent_update_request.SentUpdateRequest(props=None, base_obj=None)

Bases: object

Smartsheet SentUpdateRequest data model.

column_ids
id_
include_attachments
include_discussions
message
row_ids
sent_at
sent_by
sent_to
status
subject
to_dict()
to_json()
update_request_id

smartsheet.models.server_info module

class smartsheet.models.server_info.ServerInfo(props=None, base_obj=None)

Bases: object

Smartsheet ServerInfo data model.

formats
supported_locales
to_dict()
to_json()

smartsheet.models.share module

class smartsheet.models.share.Share(props=None, base_obj=None)

Bases: object

Smartsheet Share data model.

access_level
cc_me
created_at
email
group_id
id_
message
modified_at
name
scope
subject
to_dict()
to_json()
type_
user_id

smartsheet.models.sheet module

class smartsheet.models.sheet.Sheet(props=None, base_obj=None)

Bases: object

Smartsheet Sheet data model.

access_level
add_columns(list_of_columns)
add_rows(list_of_rows)
attach_url(attachment_obj)
attachments
columns
create_discussion(title, comment, _file=None)
created_at
delete_column(column_id)
delete_rows(object_ids, ignore_rows_not_found=False)
delete_share(share_id)
dependencies_enabled
discussions
effective_attachment_options
favorite
filters
from_id
gantt_enabled
get_all_discussions(include=None, page_size=100, page=1, include_all=False)
get_column(column_id, include=None)
get_column_by_title(title)
get_columns(include=None, page_size=100, page=1, include_all=False)
get_publish_status()
get_row(row_id, include=None, exclude=None)
get_share(share_id)
get_version()
id_
list_shares(page_size=100, page=1, include_all=False)
modified_at
name
owner
owner_id
project_settings
read_only
resource_management_enabled
rows
set_publish_status(sheet_publish_obj)
share(share_obj, send_email=False)
shares(page_size=100, page=1, include_all=False)
show_parent_rows_for_filters
source
to_dict()
to_json()
total_row_count
update_name(new_name)
update_share(share_id, share_obj)
user_settings
version

smartsheet.models.sheet_email module

class smartsheet.models.sheet_email.SheetEmail(props=None, base_obj=None)

Bases: smartsheet.models.email.Email

Smartsheet SheetEmail data model.

format_
format_details
to_dict()
to_json()

smartsheet.models.sheet_filter module

class smartsheet.models.sheet_filter.SheetFilter(props=None, base_obj=None)

Bases: object

Smartsheet SheetFilter data model.

filter_type
id_
name
query
to_dict()
to_json()

smartsheet.models.sheet_filter_details module

class smartsheet.models.sheet_filter_details.SheetFilterDetails(props=None, base_obj=None)

Bases: object

Smartsheet SheetFilterDetails data model.

criteria
include_parent
operator
to_dict()
to_json()

smartsheet.models.sheet_publish module

class smartsheet.models.sheet_publish.SheetPublish(props=None, base_obj=None)

Bases: object

Smartsheet SheetPublish data model.

ical_enabled
ical_url
read_only_full_accessible_by
read_only_full_default_view
read_only_full_enabled
read_only_full_show_toolbar
read_only_full_url
read_only_lite_enabled
read_only_lite_ssl_url
read_only_lite_url
read_write_accessible_by
read_write_default_view
read_write_enabled
read_write_show_toolbar
read_write_url
to_dict()
to_json()

smartsheet.models.sheet_user_settings module

class smartsheet.models.sheet_user_settings.SheetUserSettings(props=None, base_obj=None)

Bases: object

Smartsheet SheetUserSettings data model.

applied_sheet_filter_id
critical_path_enabled
display_summary_tasks
to_dict()
to_json()

smartsheet.models.shortcut_data_item module

class smartsheet.models.shortcut_data_item.ShortcutDataItem(props=None, base_obj=None)

Bases: object

Smartsheet ShortcutDataItem data model.

attachment_type
label
label_format
mime_type
order
to_dict()
to_json()

smartsheet.models.sight module

class smartsheet.models.sight.Sight(props=None, base_obj=None)

Bases: object

Smartsheet Sight data model.

access_level
column_count
created_at
favorite
id_
modified_at
name
to_dict()
to_json()
widgets
workspace

smartsheet.models.sight_publish module

class smartsheet.models.sight_publish.SightPublish(props=None, base_obj=None)

Bases: object

Smartsheet SightPublish data model.

read_only_full_accessible_by
read_only_full_enabled
read_only_full_url
to_dict()
to_json()

smartsheet.models.source module

class smartsheet.models.source.Source(props=None, base_obj=None)

Bases: object

Smartsheet Source data model.

id_
to_dict()
to_json()
type_

smartsheet.models.string_object_value module

class smartsheet.models.string_object_value.StringObjectValue(value=None, base_obj=None)

Bases: smartsheet.models.primitive_object_value.PrimitiveObjectValue

Smartsheet StringObjectValue data model.

object_type

smartsheet.models.template module

class smartsheet.models.template.Template(props=None, base_obj=None)

Bases: object

Smartsheet Template data model.

access_level
blank
categories
description
global_template
id_
image
large_image
locale
name
tags
to_dict()
to_json()
type

smartsheet.models.update_request module

class smartsheet.models.update_request.UpdateRequest(props=None, base_obj=None)

Bases: smartsheet.models.multi_row_email.MultiRowEmail

Smartsheet UpdateRequest data model.

created_at
id_
modified_at
schedule
sent_by
to_dict()
to_json()

smartsheet.models.user module

class smartsheet.models.user.User(props=None, base_obj=None)

Bases: smartsheet.models.user_model.UserModel

Smartsheet User data model.

name
to_dict()
to_json()

smartsheet.models.user_model module

class smartsheet.models.user_model.UserModel(props=None, base_obj=None)

Bases: object

Smartsheet UserModel data model.

admin
alternate_emails
custom_welcome_screen_viewed
email
first_name
group_admin
id_
last_login
last_name
licensed_sheet_creator
resource_viewer
sheet_count
status
to_dict()
to_json()

smartsheet.models.user_profile module

class smartsheet.models.user_profile.UserProfile(props=None, base_obj=None)

Bases: smartsheet.models.user_model.UserModel

Smartsheet UserProfile data model.

account
locale
time_zone
to_dict()
to_json()

smartsheet.models.version module

class smartsheet.models.version.Version(props=None, base_obj=None)

Bases: object

Smartsheet Version data model.

to_dict()
to_json()
version

smartsheet.models.webhook module

class smartsheet.models.webhook.Webhook(props=None, base_obj=None)

Bases: object

Smartsheet Webhook data model.

api_client_id
api_client_name
callback_url
created_at
disabled_details
enabled
events
id_
modified_at
name
scope
scope_object_id
shared_secret
stats
status
to_dict()
to_json()
version

smartsheet.models.webhook_secret module

class smartsheet.models.webhook_secret.WebhookSecret(props=None, base_obj=None)

Bases: object

Smartsheet WebhookSecret data model.

shared_secret
to_dict()
to_json()

smartsheet.models.webhook_stats module

class smartsheet.models.webhook_stats.WebhookStats(props=None, base_obj=None)

Bases: object

Smartsheet WebhookStats data model.

last_callback_attempt
last_callback_attempt_retry_count
last_successful_callback
to_dict()
to_json()

smartsheet.models.widget module

class smartsheet.models.widget.Widget(props=None, base_obj=None)

Bases: object

Smartsheet Widget data model.

contents
height
id_
show_title
show_title_icon
title
title_format
to_dict()
to_json()
type
version
width
x_position
y_position

smartsheet.models.widget_content module

class smartsheet.models.widget_content.WidgetContent(props=None, base_obj=None)

Bases: object

Smartsheet WidgetContent data model.

background_color
cell_data
columns
file_name
format_
height
html
html_content
private_id
shortcut_data
to_dict()
to_json()
width

smartsheet.models.workspace module

class smartsheet.models.workspace.Workspace(props=None, base_obj=None)

Bases: object

Smartsheet Workspace data model.

access_level
favorite
folders
id_
name
reports
sheets
sights
templates
to_dict()
to_json()

Module contents