TodoClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewToDoInFolderV2': {'operation_id': 'OnNewToDoInFolderV2', 'path': '/{connectionId}/v2/trigger/onNewToDoInFolder/{folderId}', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': 'ToDo'}, 'OnUpdateToDoInFolderV2': {'operation_id': 'OnUpdateToDoInFolderV2', 'path': '/{connectionId}/v2/trigger/onUpdateToDoInFolder/{folderId}', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': 'ToDo'}}

Classes

TodoList dataclass

TodoList(*, etag: Optional[str] = None, id: Optional[str] = None, display_name: Optional[str] = None, wellknown_list_name: Optional[str] = None, is_owner: Optional[bool] = None, is_shared: Optional[bool] = None)

Response for Update a to-do list

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique identifier of the to-do list.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Name of the to-do list.

wellknown_list_name class-attribute instance-attribute

wellknown_list_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'wellknownListName'})

Property indicating the well-known list name if the given list is a well-known list. Possible values are: none, defaultList, flaggedEmails, unknownFutureValue.

is_owner class-attribute instance-attribute

is_owner: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOwner'})

True if the user is owner of the given task list.

is_shared class-attribute instance-attribute

is_shared: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isShared'})

True if the task list is shared with other users.

ToDo dataclass

ToDo(*, context: Optional[str] = None, etag: Optional[str] = None, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, body: Optional[Dict[str, Any]] = None, body_last_modified_date_time: Optional[str] = None, completed_date_time: Optional[Dict[str, Any]] = None, due_date_time: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, is_reminder_on: Optional[bool] = None, reminder_date_time: Optional[Dict[str, Any]] = None, status: Optional[str] = None, title: Optional[str] = None)

Response for Add a to-do

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique identifier of the to-do.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

YYYY-MM-DDThh:mm:ssZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

YYYY-MM-DDThh:mm:ssZ (UTC format)

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

To-do body that typically contains information about the to-do.

body_last_modified_date_time class-attribute instance-attribute

body_last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bodyLastModifiedDateTime'})

YYYY-MM-DDThh:mm:ssZ (UTC format)

completed_date_time class-attribute instance-attribute

completed_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completedDateTime'})

The date in the specified time zone that the task was finished.

due_date_time class-attribute instance-attribute

due_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})

The date in the specified time zone that the task is to be finished.

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True)

Low, normal or high.

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

True if an alert is set to remind the user of the to-do.

reminder_date_time class-attribute instance-attribute

reminder_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderDateTime'})

The date and time for a reminder alert of the task to occur.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Brief description or title of the to-do.

ToDoHtml dataclass

ToDoHtml(*, context: Optional[str] = None, id_2: Optional[str] = None, etag: Optional[str] = None, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, categories: Optional[List[str]] = None, assigned_to: Optional[str] = None, body: Optional[Dict[str, Any]] = None, completed_date_time: Optional[Dict[str, Any]] = None, due_date_time: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, is_reminder_on: Optional[bool] = None, owner: Optional[str] = None, parent_folder_id: Optional[str] = None, reminder_date_time: Optional[Dict[str, Any]] = None, start_date_time: Optional[Dict[str, Any]] = None, status: Optional[str] = None, subject: Optional[str] = None)

Definition: ToDoHtml

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique identifier of the to-do.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

YYYY-MM-DDThh:mm:ssZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

YYYY-MM-DDThh:mm:ssZ (UTC format)

categories class-attribute instance-attribute

categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

Collection of category names associated with the to-do.

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignedTo'})

Name of the person who has been assigned the to-do.

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

To-do body that typically contains information about the to-do.

completed_date_time class-attribute instance-attribute

completed_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completedDateTime'})

Date-time in the UTC time zone when the to-do was finished.

due_date_time class-attribute instance-attribute

due_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})

Date in the UTC time zone when the to-do is to be finished.

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True)

Low, normal or high.

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

True if an alert is set to remind the user of the to-do.

owner class-attribute instance-attribute

owner: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the person who created the to-do.

parent_folder_id class-attribute instance-attribute

parent_folder_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentFolderId'})

Unique identifier of the parent folder.

reminder_date_time class-attribute instance-attribute

reminder_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderDateTime'})

Date-time in the UTC time zone for a reminder alert of the to-do to occur.

start_date_time class-attribute instance-attribute

start_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})

Date in the UTC time zone when the to-do is to begin.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.

subject class-attribute instance-attribute

subject: Optional[str] = dataclass_field(default=None, kw_only=True)

Brief description or title of the to-do.

CreateToDoBody dataclass

CreateToDoBody(subject: str, *, due_date_time: Optional[Dict[str, Any]] = None, reminder_date_time: Optional[Dict[str, Any]] = None, start_date_time: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, status: Optional[str] = None, sensitivity: Optional[str] = None, body: Optional[Dict[str, Any]] = None, categories: Optional[List[str]] = None, is_reminder_on: Optional[bool] = None)

Definition: CreateToDoBody

Attributes

due_date_time class-attribute instance-attribute

due_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DueDateTime'})

Date in the UTC time zone when the to-do is to be finished.

reminder_date_time class-attribute instance-attribute

reminder_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReminderDateTime'})

Date-time in UTC time zone for a reminder alert of the to-do to occur.

start_date_time class-attribute instance-attribute

start_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDateTime'})

Date in the UTC time zone when the to-do is to begin.

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})

Low, normal or high.

subject class-attribute instance-attribute

subject: str = dataclass_field(metadata={'wire_name': 'Subject'})

Brief description or title of the to-do.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.

sensitivity class-attribute instance-attribute

sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})

Indicates the level of privacy for the event.

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Body'})

To-do body that typically contains information about the to-do.

categories class-attribute instance-attribute

categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Categories'})

Collection of category names associated with the to-do.

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsReminderOn'})

True if an alert is set to remind the user of the to-do.

CreateToDoHtmlBody dataclass

CreateToDoHtmlBody(subject: str, *, due_date_time: Optional[Dict[str, Any]] = None, reminder_date_time: Optional[Dict[str, Any]] = None, start_date_time: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, status: Optional[str] = None, sensitivity: Optional[str] = None, body: Optional[Dict[str, Any]] = None, categories: Optional[List[str]] = None, is_reminder_on: Optional[bool] = None)

Definition: CreateToDoHtmlBody

Attributes

due_date_time class-attribute instance-attribute

due_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DueDateTime'})

Date in the UTC time zone when the to-do is to be finished.

reminder_date_time class-attribute instance-attribute

reminder_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReminderDateTime'})

Date-time in UTC time zone for a reminder alert of the to-do to occur.

start_date_time class-attribute instance-attribute

start_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDateTime'})

Date in the UTC time zone when the to-do is to begin.

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})

Low, normal or high.

subject class-attribute instance-attribute

subject: str = dataclass_field(metadata={'wire_name': 'Subject'})

Brief description or title of the to-do.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.

sensitivity class-attribute instance-attribute

sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})

Indicates the level of privacy for the event.

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Body'})

To-do body that typically contains information about the to-do.

categories class-attribute instance-attribute

categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Categories'})

Collection of category names associated with the to-do.

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsReminderOn'})

True if an alert is set to remind the user of the to-do.

UpdateToDoBody dataclass

UpdateToDoBody(*, due_date_time: Optional[Dict[str, Any]] = None, reminder_date_time: Optional[Dict[str, Any]] = None, start_date_time: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, subject: Optional[str] = None, status: Optional[str] = None, sensitivity: Optional[str] = None, body: Optional[Dict[str, Any]] = None, categories: Optional[List[str]] = None, is_reminder_on: Optional[bool] = None)

Definition: UpdateToDoBody

Attributes

due_date_time class-attribute instance-attribute

due_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DueDateTime'})

Date in the UTC time zone when the to-do is to be finished.

reminder_date_time class-attribute instance-attribute

reminder_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReminderDateTime'})

Date-time in UTC time zone for a reminder alert of the to-do to occur.

start_date_time class-attribute instance-attribute

start_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDateTime'})

Date in the UTC time zone when the to-do is to begin.

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})

Low, normal or high.

subject class-attribute instance-attribute

subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})

Brief description or title of the to-do.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.

sensitivity class-attribute instance-attribute

sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})

Indicates the level of privacy for the event.

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Body'})

To-do body that typically contains information about the to-do.

categories class-attribute instance-attribute

categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Categories'})

Collection of category names associated with the to-do.

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsReminderOn'})

True if an alert is set to remind the user of the to-do.

CreateToDoListBody dataclass

CreateToDoListBody(name: str)

Definition: CreateToDoListBody

Attributes

name instance-attribute

name: str

List name

CreateToDo dataclass

CreateToDo(title: str, *, due_date_time: Optional[Dict[str, Any]] = None, reminder_date_time: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, status: Optional[str] = None, body: Optional[Dict[str, Any]] = None, is_reminder_on: Optional[bool] = None)

Definition: CreateToDo

Attributes

due_date_time class-attribute instance-attribute

due_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})

Date in the UTC time zone when the to-do is to be finished (note the time portion will be ignored).

reminder_date_time class-attribute instance-attribute

reminder_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderDateTime'})

Date-time in UTC time zone for a reminder alert of the to-do to occur.

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True)

Low, normal or high.

title instance-attribute

title: str

Brief description or title of the to-do.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

To-do body that typically contains information about the to-do.

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

True if an alert is set to remind the user of the to-do.

UpdateToDo dataclass

UpdateToDo(*, due_date_time: Optional[Dict[str, Any]] = None, reminder_date_time: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, title: Optional[str] = None, status: Optional[str] = None, body: Optional[Dict[str, Any]] = None, is_reminder_on: Optional[bool] = None)

Definition: UpdateToDo

Attributes

due_date_time class-attribute instance-attribute

due_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dueDateTime'})

Date in the UTC time zone when the to-do is to be finished (note the time portion will be ignored).

reminder_date_time class-attribute instance-attribute

reminder_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderDateTime'})

Date-time in UTC time zone for a reminder alert of the to-do to occur.

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True)

Low, normal or high.

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Brief description or title of the to-do.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

To-do body that typically contains information about the to-do.

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

True if an alert is set to remind the user of the to-do.

CreateToDoList dataclass

CreateToDoList(display_name: str)

Definition: CreateToDoList

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

List name

TodoClient

TodoClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for todo connector.

Initialize a TodoClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

update_to_do_list async

update_to_do_list(input: CreateToDoList | Mapping[str, Any], folder_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a to-do list

This operation is used to update a specific to-do list.

Swagger operation ID: UpdateToDoList.

Parameters:

Name	Type	Description	Default
input	CreateToDoList | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
folder_id	str	To-do list.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_to_do_list async

delete_to_do_list(folder_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a to-do list

This operation is used to delete a specific to-do list.

Swagger operation ID: DeleteToDoList.

Parameters:

Name	Type	Description	Default
folder_id	str	To-do list.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_to_do async

create_to_do(input: CreateToDo | Mapping[str, Any], folder_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add a to-do

This operation is used to create a to-do in the specified to-do list.

Swagger operation ID: CreateToDoV3.

Parameters:

Name	Type	Description	Default
input	CreateToDo | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
folder_id	str	To-do list.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_to_do_list async

create_to_do_list(input: CreateToDoList | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a to-do list

This operation is used to create a new to-do list.

Swagger operation ID: CreateToDoListV2.

Parameters:

Name	Type	Description	Default
input	CreateToDoList | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_to_do async

delete_to_do(folder_id: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete to-do

This operation is used to delete a task.

Swagger operation ID: DeleteToDoV2.

Parameters:

Name	Type	Description	Default
folder_id	str	To-do list.	required
id	str	To-do task.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_todo_lists

list_all_todo_lists(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all to-do lists

Returns a list of all the to-do lists.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllTodoListsV2.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_to_do async

get_to_do(folder_id: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a to-do

This operation is used to get the to-do with the given Id.

Swagger operation ID: GetToDoV3.

Parameters:

Name	Type	Description	Default
folder_id	str	To-do list.	required
id	str	To-do task.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_to_do_list async

get_to_do_list(folder_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a to-do list

This operation is used to get a specific to-do list.

Swagger operation ID: GetToDoListV2.

Parameters:

Name	Type	Description	Default
folder_id	str	To-do list.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_to_dos_by_folder

list_to_dos_by_folder(folder_id: str, *, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List to-dos by folder

This operation is used to retrieve all to-dos from a specific list.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListToDosByFolderV2.

Parameters:

Name	Type	Description	Default
folder_id	str	To-do list.	required
top	Optional[int]	Total number of entries to retrieve (default = 10, maximum = 999).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_to_do async

update_to_do(input: UpdateToDo | Mapping[str, Any], folder_id: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update to-do

This operation is used to update a specific to-do.

Swagger operation ID: UpdateToDoV2.

Parameters:

Name	Type	Description	Default
input	UpdateToDo | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
folder_id	str	To-do list.	required
id	str	To-do task.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.