ovok_sdk.resources.registration

Sign-up requests for ovok.auth.register and ovok.auth.register_practitioner.

RegistrationCopy Anchor Link

Registration(email: str, password: str, password_confirm: str, name: str, surname: str)

A practitioner sign-up; the tenant comes from the client's config, as it does for login.

Parameters

body_for()Copy Anchor Link

body_for(tenant_code: str) -> dict[str, Any]

Build the request body for a tenant; the confirmation is checked here and never sent.

Parameters

Returns

• dict[str, Any]: The JSON body the register route takes.

Raises

• OvokValidationError: The password and its confirmation differ.

PatientRegistrationCopy Anchor Link

PatientRegistration(
    email: str,
    password: str,
    password_confirm: str,
    name: str,
    surname: str,
    continue_as_patient_token: str | None = None,
)

Bases: Registration

A patient sign-up.

Parameters

body_for()Copy Anchor Link

body_for(tenant_code: str) -> dict[str, Any]

Build the request body for a tenant, with the continuation token when set.

Parameters

Returns

• dict[str, Any]: The JSON body the register route takes.

Raises

• OvokValidationError: The password and its confirmation differ.

ClinicianInviteCopy Anchor Link

ClinicianInvite(status: Literal['clinician-invite'] = 'clinician-invite')

The project routed the email to a clinician invitation, so no one is signed in.

is_clinician_invite()Copy Anchor Link

is_clinician_invite(response: Mapping[str, Any]) -> bool

Tell whether a register response routed the email to a clinician invitation.

Parameters

Returns

• bool: True when the next step is a clinician invitation.