legal
Legal endpoint handlers.
LegalEndpoint
¶
Bases: BaseEndpoint
Handles legal document and license-related API endpoints.
Provides access to terms, privacy policies, and licenses.
commercial_license(version=None)
async
¶
Get the commercial license text.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
version
|
int | None
|
The document version to return; the latest when omitted |
None
|
Returns:
| Type | Description |
|---|---|
LegalDocument
|
Commercial license document |
Raises:
| Type | Description |
|---|---|
AuthenticationError
|
If not authenticated |
licenses(version=None)
async
¶
Get all available licenses.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
version
|
int | None
|
The version to return for every licence; the latest when omitted |
None
|
Returns:
| Type | Description |
|---|---|
list[LegalDocumentShort]
|
List of available licenses (short form) |
Raises:
| Type | Description |
|---|---|
AuthenticationError
|
If not authenticated |
non_commercial_license(version=None)
async
¶
Get the non-commercial license text.
Covers research, education, and personal use.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
version
|
int | None
|
The document version to return; the latest when omitted |
None
|
Returns:
| Type | Description |
|---|---|
LegalDocument
|
Non-commercial license document |
Raises:
| Type | Description |
|---|---|
AuthenticationError
|
If not authenticated |
privacy_policy_standard(version=None)
async
¶
Get the standard privacy policy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
version
|
int | None
|
The document version to return; the latest when omitted |
None
|
Returns:
| Type | Description |
|---|---|
LegalDocument
|
Privacy policy document for standard users |
Raises:
| Type | Description |
|---|---|
AuthenticationError
|
If not authenticated |
site_agreement(version=None)
async
¶
Get the site agreement an organization's owner accepts before using its own hardware.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
version
|
int | None
|
The document version to return; the latest when omitted |
None
|
Returns:
| Type | Description |
|---|---|
LegalDocument
|
The site agreement |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
While no version is published, or for an unknown version |
terms_and_conditions_standard(version=None)
async
¶
Get the standard terms and conditions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
version
|
int | None
|
The document version to return; the latest when omitted |
None
|
Returns:
| Type | Description |
|---|---|
LegalDocument
|
Terms and conditions document for standard users |
Raises:
| Type | Description |
|---|---|
AuthenticationError
|
If not authenticated |