QuarantinedRegistrationService¶
- class QuarantinedRegistrationService[source]¶
Methods
Accept quarantined registrations.
Archive all active quarantined registrations for an email address.
Deny quarantined registrations.
List the archived quarantined registrations.
List the active quarantined registrations awaiting review.
Restore an archived quarantined registration to the active board.
- accept(json_body, *, quarantined_registration_id)[source]¶
Accept quarantined registrations.
- Parameters:
json_body (
AcceptQuarantinedRegistrationData) – The body of the request. SeeAcceptQuarantinedRegistrationDatafor information about the possible fields. You can provide this data as aAcceptQuarantinedRegistrationDataor as a dictionary.quarantined_registration_id (
str) – Registration id to accept.
- Returns:
The same-email duplicate registrations that were archived as a side effect. The accepted registration itself is deleted; the client knows its id and removes it from the active board along with these.
- Return type:
- archive(json_body)[source]¶
Archive all active quarantined registrations for an email address.
This clears duplicate signups from the board without notifying the user. Every active registration for the email is archived, not just a single row, because duplicates may span multiple pages of the list.
- Parameters:
json_body (
ArchiveQuarantinedRegistrationData) – The body of the request. SeeArchiveQuarantinedRegistrationDatafor information about the possible fields. You can provide this data as aArchiveQuarantinedRegistrationDataor as a dictionary.
- Returns:
The registrations that were archived, so the client can drop exactly those rows from the active board.
- Return type:
- deny(json_body, *, quarantined_registration_id)[source]¶
Deny quarantined registrations.
- Parameters:
json_body (
DenyQuarantinedRegistrationData) – The body of the request. SeeDenyQuarantinedRegistrationDatafor information about the possible fields. You can provide this data as aDenyQuarantinedRegistrationDataor as a dictionary.quarantined_registration_id (
str) – Registration id to accept.
- Returns:
The same-email duplicate registrations that were archived as a side effect. The denied registration itself is deleted; the client knows its id and removes it from the active board along with these.
- Return type:
- get_all_archived(*, page_size=25)[source]¶
List the archived quarantined registrations.
Separate from the active list (
get_quarantined_registrations()) because it sorts by archived_at rather than created_at, so support sees what they most recently archived first.- Parameters:
page_size (
int) – The size of a single page, maximum is 100.
- Returns:
Paginated archived registrations, most recently archived first.
- Return type:
Response[QuarantinedRegistration]
- get_all(*, page_size=25)[source]¶
List the active quarantined registrations awaiting review.
Archived registrations are listed separately by archived_at instead of created_at. Keeping them apart gives each list a fixed pagination-token shape rather than one that changes with a query flag.
- Parameters:
page_size (
int) – The size of a single page, maximum is 100.
- Returns:
Paginated active registrations, newest signup first.
- Return type:
Response[QuarantinedRegistration]