WordonlinebusinessClient

Attributes

SensitivityLabelMetadata module-attribute

SensitivityLabelMetadata = List[Dict[str, Any]]

GetFiles module-attribute

GetFiles = List[Dict[str, Any]]

Classes

CreateFileItemInput dataclass

CreateFileItemInput(additional_properties: Dict[str, Any] = dict())

Populate a Microsoft Word template

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetSourcesResponse dataclass

GetSourcesResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get sources

GetDrivesResponse dataclass

GetDrivesResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get drives

GetFileSchemaResponse dataclass

GetFileSchemaResponse(additional_properties: Dict[str, Any] = dict())

Response for Fetches the schema of the selected file

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

BlobMetadata dataclass

BlobMetadata(id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, file_locator: Optional[str] = None)

Definition: BlobMetadata

Attributes

id class-attribute instance-attribute

id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The unique identifier of the file or folder.

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the file or folder.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the file or folder.

path class-attribute instance-attribute

path: Optional[str] = field(default=None, metadata={'wire_name': 'Path'})

The path of the file or folder.

media_type class-attribute instance-attribute

media_type: Optional[str] = field(default=None, metadata={'wire_name': 'MediaType'})

The media type of the file or folder.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = field(default=None, metadata={'wire_name': 'IsFolder'})

A boolean value (true, false) to indicate whether or not the blob is a folder.

file_locator class-attribute instance-attribute

file_locator: Optional[str] = field(default=None, metadata={'wire_name': 'FileLocator'})

The file locator of the file or folder.

ContentBody dataclass

ContentBody(content: Optional[str] = None)

Definition: ContentBody

Attributes

content class-attribute instance-attribute

content: Optional[str] = None

Content of the word document

WordonlinebusinessClient

WordonlinebusinessClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for wordonlinebusiness connector.

Initialize a WordonlinebusinessClient.

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:

create_file_item_async async

create_file_item_async(input: CreateFileItemInput, source: str, drive: str, file: str) -> bytes

Populate a Microsoft Word template

Reads a Microsoft Word template to then fill the template fields with selected dynamic values to generate a Word Document.

create_word_file_with_content_async async

create_word_file_with_content_async(input: ContentBody, file_name: Optional[str] = None) -> dict[str, Any] | None

Create a Microsoft Word document with the given content

Creates a Microsoft Word file with the given content in the root directory (use only from Copilot Studio)

get_file_pdf_async async

get_file_pdf_async(source: str, drive: str, file: str, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> bytes

Convert Word Document to PDF

Gets a PDF version of the selected file

get_sources_async async

get_sources_async() -> dict[str, Any] | None

Get sources

Get a list of sources.

get_drives_async async

get_drives_async() -> dict[str, Any] | None

Get drives

Get a list of drives.

get_file_schema_async async

get_file_schema_async(source: str, drive: str, file: str) -> dict[str, Any] | None

Fetches the schema of the selected file

Fetches the schema of the selected file.