TodoClient
Attributes
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
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
class-attribute
instance-attribute
Name of the to-do list.
class-attribute
instance-attribute
wellknown_list_name: Optional[str] = field(default=None, 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.
class-attribute
instance-attribute
True if the user is owner of the given task list.
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
class-attribute
instance-attribute
YYYY-MM-DDThh:mm:ssZ (UTC format)
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
YYYY-MM-DDThh:mm:ssZ (UTC format)
class-attribute
instance-attribute
To-do body that typically contains information about the to-do.
class-attribute
instance-attribute
body_last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'bodyLastModifiedDateTime'})
YYYY-MM-DDThh:mm:ssZ (UTC format)
class-attribute
instance-attribute
completed_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'completedDateTime'})
The date in the specified time zone that the task was finished.
class-attribute
instance-attribute
due_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'dueDateTime'})
The date in the specified time zone that the task is to be finished.
class-attribute
instance-attribute
True if an alert is set to remind the user of the to-do.
class-attribute
instance-attribute
reminder_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'reminderDateTime'})
The date and time for a reminder alert of the task to occur.
class-attribute
instance-attribute
Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.
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
class-attribute
instance-attribute
YYYY-MM-DDThh:mm:ssZ (UTC format)
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})
YYYY-MM-DDThh:mm:ssZ (UTC format)
class-attribute
instance-attribute
Collection of category names associated with the to-do.
class-attribute
instance-attribute
Name of the person who has been assigned the to-do.
class-attribute
instance-attribute
To-do body that typically contains information about the to-do.
class-attribute
instance-attribute
completed_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'completedDateTime'})
Date-time in the UTC time zone when the to-do was finished.
class-attribute
instance-attribute
due_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'dueDateTime'})
Date in the UTC time zone when the to-do is to be finished.
class-attribute
instance-attribute
True if an alert is set to remind the user of the to-do.
class-attribute
instance-attribute
Name of the person who created the to-do.
class-attribute
instance-attribute
Unique identifier of the parent folder.
class-attribute
instance-attribute
reminder_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'reminderDateTime'})
Date-time in the UTC time zone for a reminder alert of the to-do to occur.
class-attribute
instance-attribute
start_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'startDateTime'})
Date in the UTC time zone when the to-do is to begin.
class-attribute
instance-attribute
Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.
dataclass
CreateToDoBody(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: CreateToDoBody
Attributes
class-attribute
instance-attribute
due_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DueDateTime'})
Date in the UTC time zone when the to-do is to be finished.
class-attribute
instance-attribute
reminder_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'ReminderDateTime'})
Date-time in UTC time zone for a reminder alert of the to-do to occur.
class-attribute
instance-attribute
start_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'StartDateTime'})
Date in the UTC time zone when the to-do is to begin.
class-attribute
instance-attribute
Low, normal or high.
class-attribute
instance-attribute
Brief description or title of the to-do.
class-attribute
instance-attribute
Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.
class-attribute
instance-attribute
Indicates the level of privacy for the event.
class-attribute
instance-attribute
To-do body that typically contains information about the to-do.
class-attribute
instance-attribute
Collection of category names associated with the to-do.
dataclass
CreateToDoHtmlBody(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: CreateToDoHtmlBody
Attributes
class-attribute
instance-attribute
due_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DueDateTime'})
Date in the UTC time zone when the to-do is to be finished.
class-attribute
instance-attribute
reminder_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'ReminderDateTime'})
Date-time in UTC time zone for a reminder alert of the to-do to occur.
class-attribute
instance-attribute
start_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'StartDateTime'})
Date in the UTC time zone when the to-do is to begin.
class-attribute
instance-attribute
Low, normal or high.
class-attribute
instance-attribute
Brief description or title of the to-do.
class-attribute
instance-attribute
Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.
class-attribute
instance-attribute
Indicates the level of privacy for the event.
class-attribute
instance-attribute
To-do body that typically contains information about the to-do.
class-attribute
instance-attribute
Collection of category names associated with the to-do.
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
class-attribute
instance-attribute
due_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DueDateTime'})
Date in the UTC time zone when the to-do is to be finished.
class-attribute
instance-attribute
reminder_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'ReminderDateTime'})
Date-time in UTC time zone for a reminder alert of the to-do to occur.
class-attribute
instance-attribute
start_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'StartDateTime'})
Date in the UTC time zone when the to-do is to begin.
class-attribute
instance-attribute
Low, normal or high.
class-attribute
instance-attribute
Brief description or title of the to-do.
class-attribute
instance-attribute
Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.
class-attribute
instance-attribute
Indicates the level of privacy for the event.
class-attribute
instance-attribute
To-do body that typically contains information about the to-do.
class-attribute
instance-attribute
Collection of category names associated with the to-do.
dataclass
dataclass
CreateToDo(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: CreateToDo
Attributes
class-attribute
instance-attribute
due_date_time: Optional[Dict[str, Any]] = field(default=None, 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).
class-attribute
instance-attribute
reminder_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'reminderDateTime'})
Date-time in UTC time zone for a reminder alert of the to-do to occur.
class-attribute
instance-attribute
Brief description or title of the to-do.
class-attribute
instance-attribute
Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.
class-attribute
instance-attribute
To-do body that typically contains information about the to-do.
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
class-attribute
instance-attribute
due_date_time: Optional[Dict[str, Any]] = field(default=None, 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).
class-attribute
instance-attribute
reminder_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'reminderDateTime'})
Date-time in UTC time zone for a reminder alert of the to-do to occur.
class-attribute
instance-attribute
Brief description or title of the to-do.
class-attribute
instance-attribute
Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred.
class-attribute
instance-attribute
To-do body that typically contains information about the to-do.
dataclass
TodoClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)
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 |
token_provider
|
Optional[TokenProvider]
|
Optional token provider. Defaults to ManagedIdentityTokenProvider. |
None
|
options
|
Optional[ConnectorClientOptions]
|
Optional connector client options. |
None
|
Methods:
async
Update a to-do list
This operation is used to update a specific to-do list.
async
Delete a to-do list
This operation is used to delete a specific to-do list.
async
Add a to-do
This operation is used to create a to-do in the specified to-do list.
async
Create a to-do list
This operation is used to create a new to-do list.
async
Delete to-do
This operation is used to delete a task.
async
List all to-do lists
Returns a list of all the to-do lists.
async
Get a to-do
This operation is used to get the to-do with the given Id.
async
Get a to-do list
This operation is used to get a specific to-do list.
async
List to-dos by folder
This operation is used to retrieve all to-dos from a specific list.