Users Endpoint
polar_flow.endpoints.users.UsersEndpoint
Users endpoint for user management.
Provides user registration, information retrieval, and de-registration.
__init__(client)
Initialize users endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
client
|
PolarFlow
|
PolarFlow client instance |
required |
delete(user_id)
async
De-register user and revoke access.
This permanently removes the user and revokes their access token.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
int | str
|
Polar user ID |
required |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
If user not found |
get(user_id)
async
Get user information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
int | str
|
Polar user ID |
required |
Returns:
| Type | Description |
|---|---|
UserInfo
|
User profile information |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
If user not found |
register(member_id)
async
Register a new user.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
member_id
|
str
|
Partner's custom identifier for user (must be unique) |
required |
Returns:
| Type | Description |
|---|---|
UserInfo
|
User information including Polar user ID |
Raises:
| Type | Description |
|---|---|
ValidationError
|
If member_id already exists |