BoxClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewFilesV2': {'operation_id': 'OnNewFilesV2', 'path': '/{connectionId}/datasets/default/triggers/batch/onnewfileV2', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': 'BlobMetadata'}, 'OnUpdatedFilesV2': {'operation_id': 'OnUpdatedFilesV2', 'path': '/{connectionId}/datasets/default/triggers/batch/onupdatedfileV2', 'method': 'get', 'required_parameters': ['folderId'], 'callback_payload_type': 'BlobMetadata'}}

Classes

BlobMetadata dataclass

BlobMetadata(id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, last_modified: Optional[str] = None, size: Optional[int] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, e_tag: Optional[str] = None, file_locator: Optional[str] = None, last_modified_by: Optional[str] = None)

Response for Get file metadata using id

Attributes

id class-attribute instance-attribute

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

The unique id 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.

last_modified class-attribute instance-attribute

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

The date and time the file or folder was last modified.

size class-attribute instance-attribute

size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The size 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.

e_tag class-attribute instance-attribute

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

The etag of the file or folder.

file_locator class-attribute instance-attribute

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

The filelocator of the file or folder.

last_modified_by class-attribute instance-attribute

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

The user who last modified the file or folder.

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Dataset source

display_name class-attribute instance-attribute

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

Dataset display name

url_encoding class-attribute instance-attribute

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

Dataset url encoding

table_display_name class-attribute instance-attribute

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

Table display name

table_plural_name class-attribute instance-attribute

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

Table plural display name

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = None

Blob dataset source

display_name class-attribute instance-attribute

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

Blob dataset display name

url_encoding class-attribute instance-attribute

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

Blob dataset url encoding

ObjectEntity dataclass

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

Definition: Object

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])

BlobMetadataResponse dataclass

BlobMetadataResponse(id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, last_modified: Optional[str] = None, size: Optional[int] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, e_tag: Optional[str] = None, file_locator: Optional[str] = None)

Definition: BlobMetadataResponse

Attributes

id class-attribute instance-attribute

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

The unique id 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.

last_modified class-attribute instance-attribute

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

The date and time the file or folder was last modified.

size class-attribute instance-attribute

size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The size 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.

e_tag class-attribute instance-attribute

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

The etag of the file or folder.

file_locator class-attribute instance-attribute

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

The filelocator of the file or folder.

BlobMetadataPage dataclass

BlobMetadataPage(value: Optional[List[BlobMetadata]] = None)

Definition: BlobMetadataPage

Attributes

value class-attribute instance-attribute

value: Optional[List[BlobMetadata]] = None

Blob metadata collection.

BoxClient

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

Bases: ConnectorClientBase

Typed client for box connector.

Initialize a BoxClient.

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:

get_file_metadata_async async

get_file_metadata_async(id: str) -> dict[str, Any] | None

Get file metadata using id

Retrieves the file metadata from Box using file id.

update_file_async async

update_file_async(input: bytes, id: str) -> dict[str, Any] | None

Update file

Updates an existing file in Box.

delete_file_async async

delete_file_async(id: str) -> None

Delete file

Deletes an existing file from Box.

get_file_metadata_by_path_async async

get_file_metadata_by_path_async(path: str) -> dict[str, Any] | None

Get file metadata using path

Retrieves the file metadata from Box using path.

get_file_content_by_path_async async

get_file_content_by_path_async(path: str, infer_content_type: Optional[bool] = None) -> bytes

Get file content using path

Retrieves the file contents from Box using path.

get_file_content_async async

get_file_content_async(id: str, infer_content_type: Optional[bool] = None) -> bytes

Get file content using id

Retrieves the file content from Box using id.

create_file_async async

create_file_async(input: bytes, folder_path: str, name: str) -> dict[str, Any] | None

Create file

Uploads a file to Box.

copy_file_async async

copy_file_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Copy file

Copy a file to a file path in Box.

list_folder_async async

list_folder_async(id: str) -> dict[str, Any] | None

List files and folders in folder

Lists the files and folders in a Box folder.

list_root_folder_async async

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

List files and folders in root folder

Lists the files and folders in the Box root folder.

extract_folder_async async

extract_folder_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Extract archive to folder

Extracts an archive file into a folder in Box (example: .zip).