Blob Storage — Bucket Files v1

10 min

bucket_delete_file

sync(bucket_name: str, file_id: UUID, client: AuthenticatedClient | Client, permanent: bool | Unset = False) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
bucket_name	str	required
file_id	UUID	required
client	AuthenticatedClient \| Client	required
permanent	bool \| Unset	False

permanent — Default: False.

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

bucket_download_file

sync(bucket_name: str, file_id: UUID, client: AuthenticatedClient | Client) -> File | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
bucket_name	str	required
file_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: File | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

bucket_file_details

sync(bucket_name: str, file_id: UUID, client: AuthenticatedClient | Client) -> FileDetailsApiModel | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
bucket_name	str	required
file_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: FileDetailsApiModel | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

bucket_file_get_direct_access_uri

sync(bucket_name: str, file_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | list[ErrorResponse] | str | None

Parameter	Type	Default
bucket_name	str	required
file_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | list[ErrorResponse] | str | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

bucket_list_files

sync(bucket_name: str, client: AuthenticatedClient | Client, organization_ids: list[UUID] | Unset = UNSET, user_ids_created_by: list[UUID] | Unset = UNSET, user_ids_last_modified_by: list[UUID] | Unset = UNSET, user_ids_deleted_by: list[UUID] | Unset = UNSET, page_number: int | Unset = 1, page_size: int | Unset = 25, filenames: list[str] | Unset = UNSET, include_deleted_files: bool | Unset = False) -> ProblemDetails | list[ErrorResponse] | list[FileDetailsDslModel] | None

Parameter	Type	Default
bucket_name	str	required
client	AuthenticatedClient \| Client	required
organization_ids	list[UUID] \| Unset	UNSET
user_ids_created_by	list[UUID] \| Unset	UNSET
user_ids_last_modified_by	list[UUID] \| Unset	UNSET
user_ids_deleted_by	list[UUID] \| Unset	UNSET
page_number	int \| Unset	1
page_size	int \| Unset	25
filenames	list[str] \| Unset	UNSET
include_deleted_files	bool \| Unset	False

page_number — Default: 1.

page_size — Default: 25.

include_deleted_files — Default: False.

Returns: ProblemDetails | list[ErrorResponse] | list[FileDetailsDslModel] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.