Physical Information Endpoint

polar_flow.endpoints.physical_info.PhysicalInfoEndpoint

Physical information endpoint with transaction-based access.

Physical information uses a transaction pattern: 1. Create transaction 2. List/get physical information within transaction 3. Commit transaction to mark data as retrieved

__init__(client)

Initialize physical info endpoint.

Parameters:

Name	Type	Description	Default
client	PolarFlow	PolarFlow client instance	required

commit_transaction(user_id, transaction_id) async

Commit transaction and mark data as retrieved.

This should be called after retrieving all physical information to indicate the data has been successfully processed.

Parameters:

Name	Type	Description	Default
user_id	int | str	Polar user ID	required
transaction_id	int	Transaction ID to commit	required

create_transaction(user_id) async

Create transaction to access new physical information.

Parameters:

Name	Type	Description	Default
user_id	int | str	Polar user ID	required

Returns:

Type	Description
PhysicalInfoTransaction | None	Transaction metadata if new data available, None if no new data

Raises:

Type	Description
NotFoundError	If user not found

get_all(user_id) async

Convenience method to get all new physical information.

This creates a transaction, retrieves all physical info, and commits.

Parameters:

Name	Type	Description	Default
user_id	int | str	Polar user ID	required

Returns:

Type	Description
list[PhysicalInformation]	List of physical information records (empty if no new data)

get_physical_info(user_id, transaction_id, physical_info_id) async

Get specific physical information entity.

Parameters:

Name	Type	Description	Default
user_id	int | str	Polar user ID	required
transaction_id	int	Transaction ID	required
physical_info_id	int	Physical information entity ID	required

Returns:

Type	Description
PhysicalInformation	Physical information with body metrics

Raises:

Type	Description
NotFoundError	If physical info not found

list_physical_info(user_id, transaction_id) async

List physical information URLs in transaction.

Parameters:

Name	Type	Description	Default
user_id	int | str	Polar user ID	required
transaction_id	int	Transaction ID from create_transaction	required

Returns:

Type	Description
list[str]	List of physical information resource URLs