Models

This Project uses Pydantic Models. Methods on both the AsyncClient and Client will return one of the models documented below - or list thereof where applicable.

Workspace

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of this workspace.	required
name	str	The name of this workspace that is also displayed to the users.	required
active	bool	Whether this workspace is active or not.	required
size_allowance	int	The maximum allowed size of this workspace in bytes.	required
current_size	int	The current size of this workspace in bytes.	required

Model

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of this model.	required
name	str		required
active_state	Literal[str, str, str, str]	The current state of this model.	required
last_saved_serial_number	int	The serial number of the last save of this model.	required
last_modified_by_user_guid	str	The unique identifier of the user who last modified this model.	required
memory_usage	int	The memory usage of this model in bytes.	0
current_workspace_id	str	The unique identifier of the workspace that this model is currently in.	required
current_workspace_name	str	The name of the workspace that this model is currently in.	required
url	str	The current URL of this model.	required
category_values	list	The category values of this model.	required
iso_creation_date	str	The creation date of this model in ISO format.	required
last_modified	str	The last modified date of this model.	required

File

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this file.	required
name	str	The name of this file.	required
chunk_count	int	The number of chunks this file is split into.	required
delimiter	str | None	The delimiter used in this file.	None
encoding	str | None	The encoding of this file.	None
first_data_row	int	The row number of the first data row in this file.	required
format	str | None	The format of this file.	None
header_row	int	The row number of the header row in this file.	required
separator	str | None	The separator used in this file.	None

List

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this list.	required
name	str	The name of this list.	required

ListMetadata

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this list.	required
name	str	The name of this list.	required
has_selective_access	bool	Whether this list has selective access or not.	required
properties	list	The properties of this list.	[]
production_data	bool	Whether this list is production data or not.	required
managed_by	str	The user who manages this list.	required
numbered_list	bool	Whether this list is a numbered list or not.	required
use_top_level_as_page_default	bool	Whether the top level is used as the page default or not.	required
item_count	int	The number of items in this list.	required
next_item_index	int | None	The index of the next item in this list.	None
workflow_enabled	bool	Whether the workflow is enabled for this list or not.	required
permitted_items	int	The number of permitted items in this list.	required
used_in_applies_to	str | None	The applies to value of this list.	None

Action

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this action.	required
name	str	The name of this Action. This is the same as the one displayed in the Web UI.	required
type	str | None	The type of this action.	None

ListItem

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this list item.	required
name	str	The name of this list item.	required
code	str | None	The code of this list item.	None
properties	dict	The properties of this list item.	{}
subsets	dict	The subsets of this list item.	{}
parent	str | None	The parent of this list item.	None
parent_id	str | None	The unique identifier of the parent of this list item.	None

Process

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this process.	required
name	str	The name of this process.	required

Import

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this import.	required
name	str	The name of this import.	required
type	Literal[str, str, str, str, str]	The type of this import.	required
file_id	int | None	The unique identifier of the data source of this import. If it is absent, it means that the import is not a file import.	None

Export

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this export.	required
name	str	The name of this export.	required
type	Literal[str, str, str, str, str, str]	The type of this export.	required
format	str	The format of this export.	required
encoding	str | None	The encoding of this export.	None
layout	Literal[str, str, str, str, str, str]	The layout of this export, representing the Anaplan Export Structure.	required

Module

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this module.	required
name	str	The name of this module.	required

ModelStatus

Parameters:

Name	Type	Description	Default
peak_memory_usage_estimate	int | None	The peak memory usage estimate of this model.	required
peak_memory_usage_time	int | None	The peak memory usage time of this model.	required
progress	float	The progress of this model.	required
current_step	str	The current step of this model.	required
tooltip	str | None	The tooltip of this model.	required
task_id	str | None	The unique identifier of the task of this model.	required
creation_time	int	The creation time of this model.	required
export_task_type	str | None	The export task type of this model.	required

LineItem

Parameters:

Name	Type	Description	Default
id	int	The unique identifier of this line item.	required
name	str	The name of this line item.	required
module_id	int	The unique identifier of the module this line item belongs to.	required
module_name	str	The name of the module this line item belongs to.	required
format	str	The format of this line item.	required
format_metadata	dict	The format metadata of this line item.	required
summary	str	The summary of this line item.	required
applies_to	list[dict]	The applies to value of this line item.	[]
time_scale	str	The time scale of this line item.	required
time_range	str	The time range of this line item.	required
version	dict	The version of this line item.	required
style	str	The style of this line item.	required
cell_count	int | None	The cell count of this line item.	None
notes	str	The notes of this line item.	required
is_summary	bool	Whether this line item is a summary or not.	required
formula	str | None	The formula of this line item.	None
formula_scope	str	The formula scope of this line item.	required
use_switchover	bool	Whether the switchover is used or not.	required
breakback	bool	Whether the breakback is enabled or not.	required
brought_forward	bool	Whether the brought forward is enabled or not.	required
start_of_section	bool	Whether this line item is the start of a section or not.	required

Failure

Parameters:

Name	Type	Description	Default
index	int	The index of the item that failed.	required
reason	str	The reason for the failure.	required
details	str	The details of the failure.	required

InsertionResult

Parameters:

Name	Type	Description	Default
added	int	The number of items successfully added.	required
ignored	int	The number of items ignored, or items that failed.	required
total	int	The total number of items.	required
failures	list[Failure]	The list of failures.	[]

Revision

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of this revision.	required
name	str	The name of this revision.	required
description	str | None	The description of this revision. Not always present.	None
created_on	str	The creation date of this revision in ISO format.	required
created_by	str	The unique identifier of the user who created this revision.	required
creation_method	str	The creation method of this revision.	required
applied_on	str	The application date of this revision in ISO format.	required
applied_by	str	The unique identifier of the user who applied this revision.	required

ModelRevision

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of the model this revision belongs to.	required
name	str	The name of the model this revision belongs to.	required
workspace_id	str	The unique identifier of the workspace this revision belongs to.	required
applied_by	str	The unique identifier of the user who applied this revision.	required
applied_on	str	The application date of this revision in ISO format.	required
applied_method	str	The application method of this revision.	required
deleted	bool | None	Whether the model has been deleted or not.	None

SyncTask

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of this task.	required
task_state	str	The state of this task.	required
creation_time	int	The creation time of this task.	required

User

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of this user.	required
active	bool	Whether this user is active or not.	required
email	str	The email address of this user.	required
email_opt_in	bool	Whether this user has opted in to receive emails or not.	required
first_name	str	The first name of this user.	required
last_name	str	The last name of this user.	required
last_login_date	str | None	The last login date of this user in ISO format.	None

TaskSummary

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of this task.	required
task_state	Literal[str, str, str]	The state of this task.	required
creation_time	int	Unix timestamp of when this task was created.	required

TaskResultDetail

Parameters:

Name	Type	Description	Default
local_message_text	str	Error message text.	required
occurrences	int	The number of occurrences of this error.	0
type	str	The type of this error.	required
values	list[str]	Further error information if available.	[]

TaskResult

Parameters:

Name	Type	Description	Default
details	list[TaskResultDetail]	The details of this task result if available.	[]
successful	bool	Whether this task completed successfully or not.	required
failure_dump_available	bool	Whether this task completed successfully or not.	required
nested_results	list[TaskResult]	The nested results of this task, if available.	[]

TaskStatus

Parameters:

Name	Type	Description	Default
id	str	The unique identifier of this task.	required
task_state	Literal[str, str, str]	The state of this task.	required
creation_time	int	Unix timestamp of when this task was created.	required
progress	float	The progress of this task as a float between 0 and 1.	required
current_step	str | None	The current step of this task.	None
result	TaskResult | None		None