smartsheet.models package¶
Subpackages¶
- smartsheet.models.enums package
- Submodules
- smartsheet.models.enums.access_level module
- smartsheet.models.enums.attachment_parent_type module
- smartsheet.models.enums.attachment_sub_type module
- smartsheet.models.enums.attachment_type module
- smartsheet.models.enums.automation_action_frequency module
- smartsheet.models.enums.automation_action_type module
- smartsheet.models.enums.automation_rule_disabled_reason module
- smartsheet.models.enums.cell_link_status module
- smartsheet.models.enums.column_type module
- smartsheet.models.enums.criteria_target module
- smartsheet.models.enums.cross_sheet_reference_status module
- smartsheet.models.enums.currency_code module
- smartsheet.models.enums.day_descriptors module
- smartsheet.models.enums.day_ordinal module
- smartsheet.models.enums.global_template module
- smartsheet.models.enums.operator module
- smartsheet.models.enums.paper_type module
- smartsheet.models.enums.predecessor_type module
- smartsheet.models.enums.publish_accessible_by module
- smartsheet.models.enums.schedule_type module
- smartsheet.models.enums.share_scope module
- smartsheet.models.enums.share_type module
- smartsheet.models.enums.sheet_email_format module
- smartsheet.models.enums.sheet_filter_operator module
- smartsheet.models.enums.sheet_filter_type module
- smartsheet.models.enums.sort_direction module
- smartsheet.models.enums.symbol module
- smartsheet.models.enums.system_column_type module
- smartsheet.models.enums.update_request_status module
- smartsheet.models.enums.user_status module
- smartsheet.models.enums.widget_type module
- Module contents
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:
object
Smartsheet Attachment data model.
-
attachment_sub_type
¶
-
attachment_type
¶
-
created_at
¶
-
created_by
¶
-
description
¶
-
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¶
smartsheet.models.automation_action module¶
-
class
smartsheet.models.automation_action.
AutomationAction
(props=None, base_obj=None)¶ Bases:
object
Smartsheet AutomationAction data model.
-
frequency
¶
-
include_all_columns
¶
-
include_attachments
¶
-
include_discussions
¶
-
included_column_ids
¶
-
message
¶
-
recipient_column_ids
¶
-
recipients
¶
-
subject
¶
-
to_dict
()¶
-
to_json
()¶
-
type_
¶
-
smartsheet.models.automation_rule 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.PrimitiveObjectValue
Smartsheet BooleanObjectValue data model.
-
object_type
¶
-
smartsheet.models.bulk_item_failure module¶
smartsheet.models.bulk_item_result module¶
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
¶
-
hyperlink
¶
-
image
¶
-
link_in_from_cell
¶
-
links_out_to_cells
¶
-
object_value
¶
-
override_validation
¶
-
strict
¶
-
to_dict
()¶
-
to_json
()¶
-
value
¶
-
smartsheet.models.cell_data_item module¶
smartsheet.models.cell_history module¶
smartsheet.models.cell_link module¶
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_
¶
-
id_
¶
-
index
¶
-
locked
¶
-
locked_for_user
¶
-
options
¶
-
primary
¶
-
symbol
¶
-
system_column_type
¶
-
title
¶
-
to_dict
()¶
-
to_json
()¶
-
type_
¶
-
validation
¶
-
version
¶
-
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.object_value.ObjectValue
,smartsheet.models.contact.Contact
Smartsheet ContactObjectValue data model.
-
image_id
¶
-
ref_index
¶
-
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.cross_sheet_reference 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.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¶
smartsheet.models.duration module¶
smartsheet.models.email module¶
smartsheet.models.error module¶
smartsheet.models.error_result module¶
smartsheet.models.explicit_null module¶
smartsheet.models.favorite 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:
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¶
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¶
smartsheet.models.json_object module¶
smartsheet.models.multi_contact_object_value module¶
-
class
smartsheet.models.multi_contact_object_value.
MultiContactObjectValue
(props=None, base_obj=None)¶ Bases:
smartsheet.models.object_value.ObjectValue
Smartsheet MultiContactObjectValue data model.
-
values
¶
-
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¶
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¶
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¶
smartsheet.models.project_settings module¶
smartsheet.models.recipient module¶
smartsheet.models.report module¶
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¶
smartsheet.models.report_publish module¶
smartsheet.models.report_row module¶
smartsheet.models.result module¶
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
¶
-
permalink
¶
-
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¶
smartsheet.models.row_mapping module¶
smartsheet.models.schedule module¶
smartsheet.models.search_result module¶
smartsheet.models.search_result_item module¶
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¶
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
¶
-
contact_references
¶
-
create_discussion
(title, comment, _file=None)¶
-
created_at
¶
-
cross_sheet_references
¶
-
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
()¶
-
id_
¶
-
modified_at
¶
-
name
¶
-
owner
¶
-
owner_id
¶
-
permalink
¶
-
project_settings
¶
-
read_only
¶
-
resource_management_enabled
¶
-
rows
¶
-
set_publish_status
(sheet_publish_obj)¶
-
show_parent_rows_for_filters
¶
-
source
¶
-
to_dict
()¶
-
to_json
()¶
-
total_row_count
¶
-
update_name
(new_name)¶
-
user_settings
¶
-
version
¶
-
workspace
¶
-
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:
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¶
smartsheet.models.shortcut_data_item module¶
smartsheet.models.sight module¶
smartsheet.models.sight_publish module¶
smartsheet.models.sort_criterion module¶
smartsheet.models.sort_specifier 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.PrimitiveObjectValue
Smartsheet 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:
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
¶
-
company
¶
-
custom_welcome_screen_viewed
¶
-
department
¶
-
email
¶
-
first_name
¶
-
group_admin
¶
-
id_
¶
-
last_login
¶
-
last_name
¶
-
licensed_sheet_creator
¶
-
mobile_phone
¶
-
profile_image
¶
-
resource_viewer
¶
-
role
¶
-
sheet_count
¶
-
status
¶
-
title
¶
-
to_dict
()¶
-
to_json
()¶
-
work_phone
¶
-
smartsheet.models.user_profile module¶
smartsheet.models.version module¶
smartsheet.models.webhook module¶
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:
object
Smartsheet WidgetContent data model.
-
axes
¶
-
background_color
¶
-
cell_data
¶
-
columns
¶
-
file_name
¶
-
format_
¶
-
height
¶
-
html
¶
-
html_content
¶
-
hyperlink
¶
-
legend
¶
-
private_id
¶
-
series
¶
-
shortcut_data
¶
-
to_dict
()¶
-
to_json
()¶
-
url
¶
-
width
¶
-