smartsheet.models package¶
Submodules¶
smartsheet.models.access_token module¶
smartsheet.models.account module¶
smartsheet.models.alternate_email module¶
smartsheet.models.attachment module¶
-
class
smartsheet.models.attachment.Attachment(props=None, base_obj=None)¶ Bases:
objectSmartsheet Attachment data model.
-
attachment_sub_type¶
-
attachment_type¶
-
created_at¶
-
created_by¶
-
description¶
-
mime_type¶
-
name¶
-
parent_id¶
-
parent_type¶
-
pre_request_filter¶
-
size_in_kb¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
url¶
-
url_expires_in_millis¶
-
smartsheet.models.auto_number_format module¶
smartsheet.models.boolean_object_value module¶
-
class
smartsheet.models.boolean_object_value.BooleanObjectValue(value=None, base_obj=None)¶ Bases:
smartsheet.models.primitive_object_value.PrimitiveObjectValueSmartsheet BooleanObjectValue data model.
-
object_type¶
-
smartsheet.models.bulk_item_failure module¶
smartsheet.models.bulk_item_result module¶
-
class
smartsheet.models.bulk_item_result.BulkItemResult(props=None, dynamic_result_type=None, base_obj=None)¶ Bases:
objectSmartsheet BulkItemResult data model.
-
data¶ Simplify difference between Result and IndexResult
-
failed_items¶
-
message¶
-
result¶
-
result_code¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
version¶
-
smartsheet.models.cell module¶
-
class
smartsheet.models.cell.Cell(props=None, base_obj=None)¶ Bases:
objectSmartsheet Cell data model.
-
column_id¶
-
column_type¶
-
conditional_format¶
-
display_value¶
-
formula¶
-
hyperlink¶
-
image¶
-
link_in_from_cell¶
-
links_out_to_cells¶
-
object_value¶
-
override_validation¶
-
pre_request_filter¶
-
strict¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
value¶
-
smartsheet.models.cell_data_item module¶
smartsheet.models.cell_history module¶
-
class
smartsheet.models.cell_history.CellHistory(props=None, base_obj=None)¶ Bases:
smartsheet.models.cell.CellSmartsheet CellHistory data model.
-
column_id¶
-
column_type¶
-
conditional_format¶
-
display_value¶
-
formula¶
-
hyperlink¶
-
link_in_from_cell¶
-
links_out_to_cells¶
-
modified_at¶
-
modified_by¶
-
strict¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
value¶
-
smartsheet.models.cell_link module¶
smartsheet.models.column module¶
-
class
smartsheet.models.column.Column(props=None, base_obj=None)¶ Bases:
objectSmartsheet Column data model.
-
auto_number_format¶
-
contact_options¶
-
index¶
-
locked¶
-
locked_for_user¶
-
options¶
-
pre_request_filter¶
-
primary¶
-
symbol¶
-
system_column_type¶
-
title¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
validation¶
-
width¶
-
smartsheet.models.comment module¶
smartsheet.models.contact module¶
smartsheet.models.contact_object_value module¶
-
class
smartsheet.models.contact_object_value.ContactObjectValue(props=None, base_obj=None)¶ Bases:
smartsheet.models.contact.Contact,smartsheet.models.object_value.ObjectValueSmartsheet ContactObjectValue data model.
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
smartsheet.models.contact_option module¶
smartsheet.models.container_destination module¶
smartsheet.models.copy_or_move_row_destination module¶
smartsheet.models.copy_or_move_row_directive module¶
smartsheet.models.copy_or_move_row_result module¶
smartsheet.models.criteria module¶
smartsheet.models.currency module¶
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.ObjectValueSmartsheet DateObjectValue data model.
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
value¶
-
smartsheet.models.discussion module¶
-
class
smartsheet.models.discussion.Discussion(props=None, base_obj=None)¶ Bases:
objectSmartsheet Discussion data model.
-
access_level¶
-
comment¶
-
comment_attachments¶
-
comment_count¶
-
comments¶
-
created_by¶
-
last_commented_at¶
-
last_commented_user¶
-
parent_id¶
-
parent_type¶
-
pre_request_filter¶
-
read_only¶
-
title¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
smartsheet.models.downloaded_file module¶
smartsheet.models.duration module¶
smartsheet.models.email module¶
smartsheet.models.error module¶
smartsheet.models.error_result module¶
smartsheet.models.favorite module¶
smartsheet.models.filter module¶
smartsheet.models.folder module¶
smartsheet.models.font_family module¶
smartsheet.models.format_details module¶
smartsheet.models.format_tables module¶
-
class
smartsheet.models.format_tables.FormatTables(props=None, base_obj=None)¶ Bases:
objectSmartsheet 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(op_id=None, method=None)¶
-
to_json()¶
-
underline¶
-
vertical_align¶
-
smartsheet.models.group module¶
smartsheet.models.group_member module¶
smartsheet.models.home module¶
smartsheet.models.hyperlink module¶
smartsheet.models.image module¶
smartsheet.models.image_url module¶
smartsheet.models.image_url_map module¶
smartsheet.models.index_result module¶
-
class
smartsheet.models.index_result.IndexResult(props=None, dynamic_data_type=None, base_obj=None)¶ Bases:
objectSmartsheet IndexResult data model.
-
data¶
-
page_number¶
-
page_size¶
-
result¶ Simplify difference between Result and IndexResult
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
total_count¶
-
total_pages¶
-
smartsheet.models.json_object module¶
smartsheet.models.multi_row_email module¶
smartsheet.models.number_object_value module¶
-
class
smartsheet.models.number_object_value.NumberObjectValue(value=None, base_obj=None)¶ Bases:
smartsheet.models.primitive_object_value.PrimitiveObjectValueSmartsheet NumberObjectValue data model.
-
object_type¶
-
smartsheet.models.o_auth_error module¶
smartsheet.models.object_value module¶
-
class
smartsheet.models.object_value.ObjectValue(props=None, base_obj=None)¶ Bases:
objectSmartsheet ObjectValue data model.
-
object_type¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
-
smartsheet.models.object_value.enum_object_value_type(object_type=None)¶
smartsheet.models.predecessor module¶
smartsheet.models.predecessor_list module¶
smartsheet.models.primitive_object_value module¶
smartsheet.models.project_settings module¶
smartsheet.models.recipient module¶
smartsheet.models.report module¶
-
class
smartsheet.models.report.Report(props=None, base_obj=None)¶ Bases:
smartsheet.models.sheet.SheetSmartsheet Report data model.
-
access_level¶
-
attachments¶
-
columns¶
-
created_at¶
-
dependencies_enabled¶
-
discussions¶
-
effective_attachment_options¶
-
favorite¶
-
from_id¶
-
gantt_enabled¶
-
modified_at¶
-
name¶
-
owner¶
-
owner_id¶
-
permalink¶
-
read_only¶
-
resource_management_enabled¶
-
rows¶
-
show_parent_rows_for_filters¶
-
source¶
-
source_sheets¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
total_row_count¶
-
user_settings¶
-
version¶
-
smartsheet.models.report_cell module¶
-
class
smartsheet.models.report_cell.ReportCell(props=None, base_obj=None)¶ Bases:
smartsheet.models.cell.CellSmartsheet ReportCell data model.
-
column_id¶
-
column_type¶
-
conditional_format¶
-
display_value¶
-
formula¶
-
hyperlink¶
-
link_in_from_cell¶
-
links_out_to_cells¶
-
strict¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
value¶
-
virtual_column_id¶
-
smartsheet.models.report_column module¶
-
class
smartsheet.models.report_column.ReportColumn(props=None, base_obj=None)¶ Bases:
smartsheet.models.column.ColumnSmartsheet ReportColumn data model.
-
auto_number_format¶
-
index¶
-
locked¶
-
locked_for_user¶
-
options¶
-
primary¶
-
sheet_name_column¶
-
symbol¶
-
system_column_type¶
-
title¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
virtual_id¶
-
width¶
-
smartsheet.models.report_publish module¶
-
class
smartsheet.models.report_publish.ReportPublish(props=None, base_obj=None)¶ Bases:
objectSmartsheet ReportPublish data model.
-
pre_request_filter¶
-
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(op_id=None, method=None)¶
-
to_json()¶
-
smartsheet.models.report_row module¶
-
class
smartsheet.models.report_row.ReportRow(props=None, base_obj=None)¶ Bases:
smartsheet.models.row.RowSmartsheet ReportRow data model.
-
above¶
-
access_level¶
-
attachments¶
-
cells¶
-
columns¶
-
conditional_format¶
-
created_at¶
-
discussions¶
-
expanded¶
-
filtered_out¶
-
in_critical_path¶
-
locked¶
-
locked_for_user¶
-
modified_at¶
-
parent_id¶
-
permalink¶
-
row_number¶
-
sheet_id¶
-
sibling_id¶
-
to_bottom¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
to_top¶
-
version¶
-
smartsheet.models.result module¶
smartsheet.models.row module¶
-
class
smartsheet.models.row.Row(props=None, base_obj=None)¶ Bases:
objectSmartsheet Row data model.
-
above¶
-
access_level¶
-
attachments¶
-
cells¶
-
columns¶
-
conditional_format¶
-
created_at¶
-
created_by¶
-
discussions¶
-
expanded¶
-
filtered_out¶
-
get_column(column_id)¶
-
in_critical_path¶
-
indent¶
-
locked¶
-
locked_for_user¶
-
modified_at¶
-
modified_by¶
-
outdent¶
-
parent_id¶
-
permalink¶
-
pre_request_filter¶
-
row_number¶
-
set_column(column_id, replacement_cell)¶
-
sheet_id¶
-
sibling_id¶
-
to_bottom¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
to_top¶
-
version¶
-
smartsheet.models.row_email module¶
smartsheet.models.row_mapping module¶
smartsheet.models.schedule module¶
smartsheet.models.search_result module¶
smartsheet.models.search_result_item module¶
-
class
smartsheet.models.search_result_item.SearchResultItem(props=None, base_obj=None)¶ Bases:
objectSmartsheet 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(op_id=None, method=None)¶
-
to_json()¶
-
smartsheet.models.sent_update_request module¶
-
class
smartsheet.models.sent_update_request.SentUpdateRequest(props=None, base_obj=None)¶ Bases:
objectSmartsheet SentUpdateRequest data model.
-
column_ids¶
-
include_attachments¶
-
include_discussions¶
-
message¶
-
row_ids¶
-
sent_at¶
-
sent_by¶
-
sent_to¶
-
status¶
-
subject¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
update_request_id¶
-
smartsheet.models.server_info module¶
smartsheet.models.sheet module¶
-
class
smartsheet.models.sheet.Sheet(props=None, base_obj=None)¶ Bases:
objectSmartsheet 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)¶
-
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_version()¶
-
modified_at¶
-
name¶
-
owner¶
-
owner_id¶
-
permalink¶
-
pre_request_filter¶
-
project_settings¶
-
read_only¶
-
resource_management_enabled¶
-
rows¶
-
set_publish_status(sheet_publish_obj)¶
-
show_parent_rows_for_filters¶
-
source¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
total_row_count¶
-
update_name(new_name)¶
-
user_settings¶
-
version¶
-
smartsheet.models.sheet_email module¶
smartsheet.models.sheet_filter module¶
smartsheet.models.sheet_filter_details module¶
smartsheet.models.sheet_publish module¶
-
class
smartsheet.models.sheet_publish.SheetPublish(props=None, base_obj=None)¶ Bases:
objectSmartsheet SheetPublish data model.
-
ical_enabled¶
-
ical_url¶
-
pre_request_filter¶
-
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(op_id=None, method=None)¶
-
to_json()¶
-
smartsheet.models.sheet_user_settings module¶
smartsheet.models.shortcut_data_item module¶
smartsheet.models.sight module¶
smartsheet.models.sight_publish module¶
smartsheet.models.source module¶
smartsheet.models.string_object_value module¶
-
class
smartsheet.models.string_object_value.StringObjectValue(value=None, base_obj=None)¶ Bases:
smartsheet.models.primitive_object_value.PrimitiveObjectValueSmartsheet StringObjectValue data model.
-
object_type¶
-
smartsheet.models.template module¶
smartsheet.models.update_request module¶
smartsheet.models.user module¶
-
class
smartsheet.models.user.User(props=None, base_obj=None)¶ Bases:
objectSmartsheet User data model.
-
admin¶
-
alternate_emails¶
-
custom_welcome_screen_viewed¶
-
email¶
-
first_name¶
-
group_admin¶
-
last_login¶
-
last_name¶
-
licensed_sheet_creator¶
-
name¶
-
pre_request_filter¶
-
resource_viewer¶
-
sheet_count¶
-
status¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
smartsheet.models.user_profile module¶
smartsheet.models.version module¶
smartsheet.models.webhook module¶
-
class
smartsheet.models.webhook.Webhook(props=None, base_obj=None)¶ Bases:
objectSmartsheet Webhook data model.
-
api_client_id¶
-
api_client_name¶
-
callback_url¶
-
created_at¶
-
disabled_details¶
-
enabled¶
-
events¶
-
modified_at¶
-
name¶
-
pre_request_filter¶
-
scope¶
-
scope_object_id¶
-
stats¶
-
status¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
version¶
-
smartsheet.models.webhook_secret module¶
smartsheet.models.webhook_stats module¶
smartsheet.models.widget module¶
smartsheet.models.widget_content module¶
-
class
smartsheet.models.widget_content.WidgetContent(props=None, base_obj=None)¶ Bases:
objectSmartsheet WidgetContent data model.
-
background_color¶
-
cell_data¶
-
columns¶
-
file_name¶
-
format¶
-
height¶
-
html¶
-
html_content¶
-
hyperlink¶
-
private_id¶
-
shortcut_data¶
-
to_dict(op_id=None, method=None)¶
-
to_json()¶
-
width¶
-