thunderbird_accounts.client.models

Classes

`Client`(args, *kwargs)	An API client.
`ClientContact`(args, *kwargs)	A contact for a client for auditing / service info purposes.
`ClientEnvironment`(args, *kwargs)	An environment associated with a client.
`ClientWebhook`(args, *kwargs)	A webhook associated with a client's environment.

class thunderbird_accounts.client.models.ClientEnvironment(*args, **kwargs)[source]

Bases: BaseModel

An environment associated with a client. Each environment requires a redirect_url and gets an auth_token.

Parameters:

environment – The environment type (e.g. dev, stage, prod)
redirect_url – URL to redirect the login request back to
auth_token – The authentication token given to a client so they can make server-to-server requests with us
is_active – Is this environment active?
uuid (UUIDField) – Primary key: Uuid
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at
allowed_hostnames (JSONField) – Allowed hostnames. List of allowed hostnames for this client environment.
is_public (BooleanField) – Is public. Are non-users allowed to sign up? Otherwise an allow list is checked.

Relationship fields:

Parameters:: client (ForeignKey to Client) – Client (related name: clientenvironment)

Reverse relationships:

Parameters:: clientwebhook (Reverse ForeignKey from ClientWebhook) – All client webhooks of this client environment (related name of client_environment)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

class thunderbird_accounts.client.models.ClientWebhook(*args, **kwargs)[source]

Bases: BaseModel

A webhook associated with a client’s environment. Webhooks are required in every environment except for dev.

Parameters:

name – The name of the webhook (admin purposes)
webhook_url – The URL where we should send our POST requests
type – The type of webhook
uuid (UUIDField) – Primary key: Uuid
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at

Relationship fields:

Parameters:: client_environment (ForeignKey to ClientEnvironment) – Client environment (related name: clientwebhook)

class WebhookType(*values)[source]: Bases: TextChoices

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

class thunderbird_accounts.client.models.ClientContact(*args, **kwargs)[source]

Bases: BaseModel

A contact for a client for auditing / service info purposes. At least one should be required.

Parameters:

name – How the contact should be addressed. Can be full name, partial name, internet handle, etc…
email – An up-to-date active email address we could send service alerts to
website – A website (can be tied to the environment, but not required)
uuid (UUIDField) – Primary key: Uuid
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at

Relationship fields:

Parameters:: client (ForeignKey to Client) – Client (related name: clientcontact)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

class thunderbird_accounts.client.models.Client(*args, **kwargs)[source]

Bases: BaseModel

An API client. Each client will contain many environments which will be given an authentication token to send us requests with. These requests should be server-to-server only.

Parameters:

name – The name of the client.
uuid (UUIDField) – Primary key: Uuid
created_at (DateTimeField) – Created at
updated_at (DateTimeField) – Updated at

Reverse relationships:

Parameters:

clientenvironment (Reverse ForeignKey from ClientEnvironment) – All client environments of this client (related name of client)
clientcontact (Reverse ForeignKey from ClientContact) – All client contacts of this client (related name of client)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned