QuarantinedRegistrationService

class QuarantinedRegistrationService

Methods

accept	Accept quarantined registrations.
archive	Archive all active quarantined registrations for an email address.
deny	Deny quarantined registrations.
get_all	List quarantined registrations.
unarchive	Restore an archived quarantined registration to the active board.

accept(json_body, *, quarantined_registration_id)

Accept quarantined registrations.

Parameters:

• json_body (AcceptQuarantinedRegistrationData) – The body of the request. See AcceptQuarantinedRegistrationData for information about the possible fields. You can provide this data as a AcceptQuarantinedRegistrationData or as a dictionary.

• quarantined_registration_id (str) – Registration id to accept.

• self (QuarantinedRegistrationService[AuthenticatedClient])

Returns:

An empty response with return code 204

Return type:

None

archive(json_body)

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. See ArchiveQuarantinedRegistrationData for information about the possible fields. You can provide this data as a ArchiveQuarantinedRegistrationData or as a dictionary.

• self (QuarantinedRegistrationService[AuthenticatedClient])

Returns:

An empty response with return code 204

Return type:

None

deny(json_body, *, quarantined_registration_id)

Deny quarantined registrations.

Parameters:

• json_body (DenyQuarantinedRegistrationData) – The body of the request. See DenyQuarantinedRegistrationData for information about the possible fields. You can provide this data as a DenyQuarantinedRegistrationData or as a dictionary.

• quarantined_registration_id (str) – Registration id to accept.

• self (QuarantinedRegistrationService[AuthenticatedClient])

Returns:

An empty response with return code 204

Return type:

None

get_all(*, is_archived=False, page_size=25)

List quarantined registrations.

Parameters:

• is_archived (bool) – If True return archived registrations, otherwise return the active ones awaiting review.

• page_size (int) – The size of a single page, maximum is 100.

• self (QuarantinedRegistrationService[AuthenticatedClient])

Returns:

Paginated list of quarantined registrations.

Return type:

Response[QuarantinedRegistration]

unarchive(*, quarantined_registration_id)

Restore an archived quarantined registration to the active board.

Parameters:

• quarantined_registration_id (str) – Registration id to unarchive.

• self (QuarantinedRegistrationService[AuthenticatedClient])

Returns:

An empty response with return code 204

Return type:

None