antimatter.builders.settings_put

Module Contents

Classes

SettingsPutBuilder

A builder class for constructing a Settings object.

class antimatter.builders.settings_put.SettingsPutBuilder

A builder class for constructing a Settings object.

set_default_display_name(name: str) → SettingsPutBuilder

Sets the active_admin_contacts of the domain settings.

Parameters:

name – The new default display name

Returns:

The instance of the builder.

set_default_token_lifetime(lifetime: int) → SettingsPutBuilder

Sets the set_default_token_lifetime of the domain settings.

Parameters:

lifetime – The new default token lifetime

Returns:

The instance of the builder.

set_maximum_token_lifetime(lifetime: int) → SettingsPutBuilder

Sets the maximum_token_lifetime of the domain settings.

Parameters:

lifetime – The new maximin token lifetime

Returns:

The instance of the builder.

set_active_admin_contacts(contacts: List[str]) → SettingsPutBuilder

Sets the set_active_admin_contacts of the domain settings. Note: this list cannot contain any new contacts and should only be used to remove current active admin contacts. To add new active admin contacts, fist add the contacts to the pending contacts list using set_pending_admin_contacts. Once updated, a verification request will then be sent to the contact, and once verified, the contact will be converted into an active admin contact.

Parameters:

contacts – The new list of active admin contacts

Returns:

The instance of the builder.

set_pending_admin_contacts(contacts: List[str]) → SettingsPutBuilder

Sets the pending_admin_contacts of the domain settings.

Parameters:

contacts – The new list of pending admin contacts

Returns:

The instance of the builder.

build() → antimatter_api.NewDomainSettings

Builds the NewDomainSettings and returns it.

Returns:

The built NewDomainSettings.