Data model

Eventyay provides the following data(base) models. Every model and every model method or field that is not documented here is considered private and should not be used by third-party plugins, as it may change without advance notice.

User model

class eventyay.base.models.User(*args, **kwargs)

Bases: PermissionsMixin, LoggingMixin, RulesModelMixin, VersionedModel, GenerateCode, FileCleanupMixin, AbstractBaseUser

This is the unified user model used by eventyay for both authentication and video/event functionality.

Parameters:

email (str) – The user’s email address, used for identification.
fullname (str) – The user’s full name. May be empty or null.
is_active (bool) – Whether this user account is activated.
is_staff (bool) – True for system operators.
date_joined (datetime) – The datetime of the user’s registration.
locale (str) – The user’s preferred locale code.
timezone (str) – The user’s preferred timezone.

exception DoesNotExist: Bases: ObjectDoesNotExist

EMAIL_FIELD = 'email'

class ModerationState(value)

Bases: TextChoices

BANNED = 'banned'

NONE = ''

SILENCED = 'silenced'

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

REQUIRED_FIELDS = []

USERNAME_FIELD = 'email'

class UserType(value)

Bases: TextChoices

ANONYMOUS = 'anon'

KIOSK = 'kiosk'

PERSON = 'person'

property all_logentries

answers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

api_oauthaccesstoken

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

api_oauthapplication

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

api_oauthgrant

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

api_oauthidtoken

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

api_oauthrefreshtoken

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

assigned_reviews

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

audit_logs

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

auth_backend: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

auth_token

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

avatar: Just like the FileDescriptor, but for ImageFields. The only difference is assigning the width/height to the width_field/height_field, if appropriate.

avatar_license: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

avatar_source: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

avatar_thumbnail: Just like the FileDescriptor, but for ImageFields. The only difference is assigning the width/height to the width_field/height_field, if appropriate.

avatar_thumbnail_tiny: Just like the FileDescriptor, but for ImageFields. The only difference is assigning the width/height to the width_field/height_field, if appropriate.

avatar_url

bbb_invites

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

blocked_by

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

blocked_users

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

change_password(new_password)

chat_channels

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

chat_events

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

chat_notifications

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

chat_reactions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

clear_caches()

client_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

client_state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

code: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_joined: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

deleted: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

email: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

emailaddress_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

emailqueue_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_grants

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

event_id

event_profile(event)

Retrieve (and/or create) the event.

SpeakerProfile for this user.

Retval:: eventyay.base.models.profile.EventProfile

event_views

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

eventyay_log_entries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exhibitor_answered_contact_requests

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exhibitor_contact_requests

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exhibitor_staff

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exhibitor_views

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

feedback

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

fullname: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_active_staff_session(session_key=None)

get_avatar_url(event=None, thumbnail=None): Returns the full avatar URL, where user.avatar_url returns the absolute URL.

get_display_name() → str: Returns a user’s name or ‘Unnamed user’.

get_event_permission_set(organizer, event) → set

Gets a set of permissions (as strings) that a user holds for a particular event

Parameters:

organizer – The organizer of the event
event – The event to check

Returns:

set

get_events_with_any_permission(request=None)

Returns a queryset of events the user has any permissions to.

Parameters:: request – The current request (optional). Required to detect staff sessions properly.
Returns:: Iterable of Events

get_events_with_permission(permission, request=None)

Returns a queryset of events the user has a specific permissions to.

Parameters:: request – The current request (optional). Required to detect staff sessions properly.
Returns:: Iterable of Events

get_full_name() → str

Returns the first of the following user properties that is found to exist:

Full name
Wikimedia username
Email address

get_gravatar: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_locale_display(*, field=<django.db.models.fields.CharField: locale>)

get_locale_for_event(event)

get_moderation_state_display(*, field=<django.db.models.fields.CharField: moderation_state>)

get_next_by_date_joined(*, field=<django.db.models.fields.DateTimeField: date_joined>, is_next=True, **kwargs)

get_organizer_permission_set(organizer) → set

Gets a set of permissions (as strings) that a user holds for a particular organizer

Parameters:: organizer – The organizer of the event
Returns:: set

get_organizers_with_permission(permission, request=None)

Returns a queryset of organizers the user has a specific permissions to.

Parameters:: request – The current request (optional). Required to detect staff sessions properly.
Returns:: Iterable of Organizers

get_password_reset_url(event=None, orga=False)

get_permissions_for_event(event) → set

Returns a set of all permission a user has for the given event.

get_previous_by_date_joined(*, field=<django.db.models.fields.DateTimeField: date_joined>, is_next=False, **kwargs)

get_role_grants(room=None)

async get_role_grants_async(room=None)

get_session_auth_hash(): Return an HMAC that needs to

get_short_name() → str

Returns the first of the following user properties that is found to exist:

Full name
Email address

Only present for backwards compatibility

get_type_display(*, field=<django.db.models.fields.CharField: type>)

gravatar_parameter

groups

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

guid

has_active_staff_session(session_key=None): Returns whether or not a user has an active staff session (formerly known as superuser session) with the given session key.

has_avatar

has_event_permission(organizer, event, perm_name=None, request=None) → bool

Checks if this user is part of any team that grants access of type perm_name to the event event.

Parameters:

organizer – The organizer of the event
event – The event to check
perm_name – The permission, e.g. can_change_teams
request – The current request (optional). Required to detect staff sessions properly.

Returns:

bool

has_organizer_permission(organizer, perm_name=None, request=None)

Checks if this user is part of any team that grants access of type perm_name to the organizer organizer.

Parameters:

organizer – The organizer to check
perm_name – The permission, e.g. can_change_teams
request – The current request (optional). Required to detect staff sessions properly.

Returns:

bool

has_perm(perm: str, obj: Self | None = None) → bool: Return True if the user has the specified permission. Query all available auth backends, but return immediately if any backend returns True. Thus, a user who has permission from a single auth backend is assumed to have permission in general. If an object is provided, check permissions for that object.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_active: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_administrator: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property is_banned

async is_blocked_in_channel_async(channel)

async is_member_of_channel_async(channel_id)

property is_silenced

is_staff: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_superuser: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_login: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

locale: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

log_action(action: str, data: dict = None, user=None, person=None, orga: bool = False)

Create a log entry for this user.

Parameters:

action – The log action that took place.
data – Addition data to be saved.
person (User) – The person modifying this user. Defaults to this user.
orga – Was this action initiated by a privileged user?

log_entries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

logentry_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

logged_actions(): Returns all log entries that were made about this user.

mails

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

moderated_questions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

moderation_state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property name

nick: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

notification_settings: QuerySet[NotificationSetting]

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

notifications_send: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

notifications_token: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects: UserManager = <django.db.models.manager.UserManagerFromUserQuerySet object>

own_actions(): Returns all log entries that were made by this user.

password: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

poll_votes

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

poster_presenter

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

poster_votes

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

pretalx_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

profile: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

profiles

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

pw_reset_time: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

pw_reset_token: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

question_votes

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

questions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

regenerate_token() → Token: Generates a new API access token, deleting the old one.

require_2fa: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

requiredaction_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

reset_password(event, user=None, mail_text=None, orga=False)

reviews

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

room_grants

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

roulette_pairing_left

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

roulette_pairing_right

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

rouletterequest_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

send_password_reset(request: HttpRequest)

send_security_notice(messages, email=None)

serialize_public(include_admin_info=False, trait_badges_map=None, include_client_state=False): Serialize user for public display in video/event context

session_token: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

show_publicly: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

social_login_id_linkedin: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

social_login_id_twitter: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

socialaccount_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

soft_delete(): Soft delete for video/event functionality

speaker_roles

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

staffsession_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

staffsessionauditlog_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

staticdevice_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

storedfile_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

submission_comments

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

submission_favorites

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

submission_favourites

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

submissions

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

teams

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

timezone: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

token_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property top_logentries

totpdevice_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

traits: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

u2fdevice_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

update_session_token()

user_permissions

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

version: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

views

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

webauthndevice_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

wikimedia_username: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

Organizers and events

class eventyay.base.models.Organizer(*args, **kwargs)

Bases: LoggedModel, TimestampedModel, RulesModelMixin, Model

This model represents an entity organizing events, e.g. a company, institution, charity, person, …

Parameters:

name (str) – The organizer’s name
slug (str) – A globally unique, short name for this organizer, to be used in URLs and similar places.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

property accepted_gift_cards

all_logentries_link

allow_delete()

bankimportjob_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

banktransaction_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

banktransfer_refund_exports

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

billing

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

billinginvoice_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

cache: Returns an ObjectRelatedCache object. This behaves equivalent to Django’s built-in cache backends, but puts you into an isolated environment for this organizer, so you don’t have to prefix your cache keys. In addition, the cache is being cleared every time the organizer changes.

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property default_gift_card_expiry

delete_sub_objects()

devices

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

domains

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

events

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

gates

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

get_cache(): Returns an ObjectRelatedCache object. This behaves equivalent to Django’s built-in cache backends, but puts you into an isolated environment for this organizer, so you don’t have to prefix your cache keys. In addition, the cache is being cleared every time the organizer changes.

Deprecated since version 1.9: Use the property cache instead.

gift_card_collector_acceptance

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

gift_card_issuer_acceptance

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property has_gift_cards

has_unpaid_invoice()

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_vouchers

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

invoices

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

issued_gift_cards

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

meta_properties

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

oauthaccesstoken_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

oauthgrant_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

oauthidtoken_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

objects = <django.db.models.manager.Manager object>

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

seating_plans

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property settings

settings_namespace = 'organizer'

shred(person=None): Irrevocably deletes the organizer and all related events and their data.

slug: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

teams

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property timezone: ZoneInfo

updated: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

webhooks

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class eventyay.base.models.Event(*args, **kwargs)

Bases: EventMixin, LoggedModel, TimestampedModel, FileCleanupMixin, RulesModelMixin, Model

This model represents an event. An event is anything you can buy tickets for.

Parameters:

organizer (eventyay.base.models.organizer.Organizer) – The organizer this event belongs to
testmode (bool) – This event is in test mode
name (str) – This event’s full title
slug (str) – A short, alphanumeric, all-lowercase name for use in URLs. The slug has to be unique among the events of the same organizer.
live (bool) – Whether or not the shop is publicly accessible
currency (str) – The currency of all prices and payments of this event
date_from (datetime) – The datetime this event starts
date_to (datetime) – The datetime this event ends
presale_start (datetime) – No tickets will be sold before this date.
presale_end (datetime) – No tickets will be sold after this date.
location (str) – venue
plugins (str) – A comma-separated list of plugin names that are active for this event.
has_subevents (bool) – Enable event series functionality
sales_channels (list) – A list of sales channel identifiers, that this event is available for sale on

CURRENCY_CHOICES = [('AED', 'AED - UAE Dirham'), ('AFN', 'AFN - Afghani'), ('ALL', 'ALL - Lek'), ('AMD', 'AMD - Armenian Dram'), ('ANG', 'ANG - Netherlands Antillean Guilder'), ('AOA', 'AOA - Kwanza'), ('ARS', 'ARS - Argentine Peso'), ('AUD', 'AUD - Australian Dollar'), ('AWG', 'AWG - Aruban Florin'), ('AZN', 'AZN - Azerbaijan Manat'), ('BAM', 'BAM - Convertible Mark'), ('BBD', 'BBD - Barbados Dollar'), ('BDT', 'BDT - Taka'), ('BGN', 'BGN - Bulgarian Lev'), ('BHD', 'BHD - Bahraini Dinar'), ('BIF', 'BIF - Burundi Franc'), ('BMD', 'BMD - Bermudian Dollar'), ('BND', 'BND - Brunei Dollar'), ('BOB', 'BOB - Boliviano'), ('BOV', 'BOV - Mvdol'), ('BRL', 'BRL - Brazilian Real'), ('BSD', 'BSD - Bahamian Dollar'), ('BTN', 'BTN - Ngultrum'), ('BWP', 'BWP - Pula'), ('BYN', 'BYN - Belarusian Ruble'), ('BZD', 'BZD - Belize Dollar'), ('CAD', 'CAD - Canadian Dollar'), ('CDF', 'CDF - Congolese Franc'), ('CHE', 'CHE - WIR Euro'), ('CHF', 'CHF - Swiss Franc'), ('CHW', 'CHW - WIR Franc'), ('CLF', 'CLF - Unidad de Fomento'), ('CLP', 'CLP - Chilean Peso'), ('CNY', 'CNY - Yuan Renminbi'), ('COP', 'COP - Colombian Peso'), ('COU', 'COU - Unidad de Valor Real'), ('CRC', 'CRC - Costa Rican Colon'), ('CUC', 'CUC - Peso Convertible'), ('CUP', 'CUP - Cuban Peso'), ('CVE', 'CVE - Cabo Verde Escudo'), ('CZK', 'CZK - Czech Koruna'), ('DJF', 'DJF - Djibouti Franc'), ('DKK', 'DKK - Danish Krone'), ('DOP', 'DOP - Dominican Peso'), ('DZD', 'DZD - Algerian Dinar'), ('EGP', 'EGP - Egyptian Pound'), ('ERN', 'ERN - Nakfa'), ('ETB', 'ETB - Ethiopian Birr'), ('EUR', 'EUR - Euro'), ('FJD', 'FJD - Fiji Dollar'), ('FKP', 'FKP - Falkland Islands Pound'), ('GBP', 'GBP - Pound Sterling'), ('GEL', 'GEL - Lari'), ('GHS', 'GHS - Ghana Cedi'), ('GIP', 'GIP - Gibraltar Pound'), ('GMD', 'GMD - Dalasi'), ('GNF', 'GNF - Guinean Franc'), ('GTQ', 'GTQ - Quetzal'), ('GYD', 'GYD - Guyana Dollar'), ('HKD', 'HKD - Hong Kong Dollar'), ('HNL', 'HNL - Lempira'), ('HRK', 'HRK - Kuna'), ('HTG', 'HTG - Gourde'), ('HUF', 'HUF - Forint'), ('IDR', 'IDR - Rupiah'), ('ILS', 'ILS - New Israeli Sheqel'), ('INR', 'INR - Indian Rupee'), ('IQD', 'IQD - Iraqi Dinar'), ('IRR', 'IRR - Iranian Rial'), ('ISK', 'ISK - Iceland Krona'), ('JMD', 'JMD - Jamaican Dollar'), ('JOD', 'JOD - Jordanian Dinar'), ('JPY', 'JPY - Yen'), ('KES', 'KES - Kenyan Shilling'), ('KGS', 'KGS - Som'), ('KHR', 'KHR - Riel'), ('KMF', 'KMF - Comorian Franc'), ('KPW', 'KPW - North Korean Won'), ('KRW', 'KRW - Won'), ('KWD', 'KWD - Kuwaiti Dinar'), ('KYD', 'KYD - Cayman Islands Dollar'), ('KZT', 'KZT - Tenge'), ('LAK', 'LAK - Lao Kip'), ('LBP', 'LBP - Lebanese Pound'), ('LKR', 'LKR - Sri Lanka Rupee'), ('LRD', 'LRD - Liberian Dollar'), ('LSL', 'LSL - Loti'), ('LYD', 'LYD - Libyan Dinar'), ('MAD', 'MAD - Moroccan Dirham'), ('MDL', 'MDL - Moldovan Leu'), ('MGA', 'MGA - Malagasy Ariary'), ('MKD', 'MKD - Denar'), ('MMK', 'MMK - Kyat'), ('MNT', 'MNT - Tugrik'), ('MOP', 'MOP - Pataca'), ('MRU', 'MRU - Ouguiya'), ('MUR', 'MUR - Mauritius Rupee'), ('MVR', 'MVR - Rufiyaa'), ('MWK', 'MWK - Malawi Kwacha'), ('MXN', 'MXN - Mexican Peso'), ('MXV', 'MXV - Mexican Unidad de Inversion (UDI)'), ('MYR', 'MYR - Malaysian Ringgit'), ('MZN', 'MZN - Mozambique Metical'), ('NAD', 'NAD - Namibia Dollar'), ('NGN', 'NGN - Naira'), ('NIO', 'NIO - Cordoba Oro'), ('NOK', 'NOK - Norwegian Krone'), ('NPR', 'NPR - Nepalese Rupee'), ('NZD', 'NZD - New Zealand Dollar'), ('OMR', 'OMR - Rial Omani'), ('PAB', 'PAB - Balboa'), ('PEN', 'PEN - Sol'), ('PGK', 'PGK - Kina'), ('PHP', 'PHP - Philippine Peso'), ('PKR', 'PKR - Pakistan Rupee'), ('PLN', 'PLN - Zloty'), ('PYG', 'PYG - Guarani'), ('QAR', 'QAR - Qatari Rial'), ('RON', 'RON - Romanian Leu'), ('RSD', 'RSD - Serbian Dinar'), ('RUB', 'RUB - Russian Ruble'), ('RWF', 'RWF - Rwanda Franc'), ('SAR', 'SAR - Saudi Riyal'), ('SBD', 'SBD - Solomon Islands Dollar'), ('SCR', 'SCR - Seychelles Rupee'), ('SDG', 'SDG - Sudanese Pound'), ('SEK', 'SEK - Swedish Krona'), ('SGD', 'SGD - Singapore Dollar'), ('SHP', 'SHP - Saint Helena Pound'), ('SLE', 'SLE - Leone'), ('SLL', 'SLL - Leone'), ('SOS', 'SOS - Somali Shilling'), ('SRD', 'SRD - Surinam Dollar'), ('SSP', 'SSP - South Sudanese Pound'), ('STN', 'STN - Dobra'), ('SVC', 'SVC - El Salvador Colon'), ('SYP', 'SYP - Syrian Pound'), ('SZL', 'SZL - Lilangeni'), ('THB', 'THB - Baht'), ('TJS', 'TJS - Somoni'), ('TMT', 'TMT - Turkmenistan New Manat'), ('TND', 'TND - Tunisian Dinar'), ('TOP', 'TOP - Pa’anga'), ('TRY', 'TRY - Turkish Lira'), ('TTD', 'TTD - Trinidad and Tobago Dollar'), ('TWD', 'TWD - New Taiwan Dollar'), ('TZS', 'TZS - Tanzanian Shilling'), ('UAH', 'UAH - Hryvnia'), ('UGX', 'UGX - Uganda Shilling'), ('USD', 'USD - US Dollar'), ('USN', 'USN - US Dollar (Next day)'), ('UYI', 'UYI - Uruguay Peso en Unidades Indexadas (UI)'), ('UYU', 'UYU - Peso Uruguayo'), ('UYW', 'UYW - Unidad Previsional'), ('UZS', 'UZS - Uzbekistan Sum'), ('VED', 'VED - Bolívar Soberano'), ('VES', 'VES - Bolívar Soberano'), ('VND', 'VND - Dong'), ('VUV', 'VUV - Vatu'), ('WST', 'WST - Tala'), ('XAF', 'XAF - CFA Franc BEAC'), ('XAG', 'XAG - Silver'), ('XAU', 'XAU - Gold'), ('XBA', 'XBA - Bond Markets Unit European Composite Unit (EURCO)'), ('XBB', 'XBB - Bond Markets Unit European Monetary Unit (E.M.U.-6)'), ('XBC', 'XBC - Bond Markets Unit European Unit of Account 9 (E.U.A.-9)'), ('XBD', 'XBD - Bond Markets Unit European Unit of Account 17 (E.U.A.-17)'), ('XCD', 'XCD - East Caribbean Dollar'), ('XDR', 'XDR - SDR (Special Drawing Right)'), ('XOF', 'XOF - CFA Franc BCEAO'), ('XPD', 'XPD - Palladium'), ('XPF', 'XPF - CFP Franc'), ('XPT', 'XPT - Platinum'), ('XSU', 'XSU - Sucre'), ('XTS', 'XTS - Codes specifically reserved for testing purposes'), ('XUA', 'XUA - ADB Unit of Account'), ('XXX', 'XXX - The codes assigned for transactions where no currency is involved'), ('YER', 'YER - Yemeni Rial'), ('ZAR', 'ZAR - Rand'), ('ZMW', 'ZMW - Zambian Kwacha'), ('ZWL', 'ZWL - Zimbabwe Dollar')]

exception DoesNotExist: Bases: ObjectDoesNotExist

HEADER_PATTERN_CHOICES = (('', 'Plain'), ('pcb', 'Circuits'), ('bubbles', 'Circles'), ('signal', 'Signal'), ('topo', 'Topography'), ('graph', 'Graph Paper'))

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

active_review_phase

allow_delete()

announcements

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

anonymous_invites

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

audits

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

availabilities

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

available_content_locales

available_plugins

badge_layouts

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

bankimportjob_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

banktransaction_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

banktransfer_refund_exports

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

bbb_calls

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

bbbserver_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

billinginvoice_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

build_initial_data()

cache: Returns an ObjectRelatedCache object. This behaves equivalent to Django’s built-in cache backends, but puts you into an isolated environment for this event, so you don’t have to prefix your cache keys. In addition, the cache is being cleared every time the event or one of its related objects change.

cartposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

categories

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

cfp

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

cfp_flow

channels

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

checkin_lists

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

static clean_dates(date_from, date_to)

static clean_has_subevents(event, has_subevents)

clean_live()

static clean_presale(presale_start, presale_end)

static clean_slug(organizer, event, slug)

clear_data(): Clears all personal information. It generally leaves structure such as rooms and exhibitors intact, but to make sure all personal data is scrubbed, it also clears all uploaded files, which includes things like exhibitor logos.

clone_from(old, new_secrets)

comment: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

config: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

content_locale_array: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

content_locales: Is a list of active content locales.

copy_data_from(other)

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

currency: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

current_schedule

custom_css

The descriptor for the file attribute on the model instance. Return a FieldFile when accessed so you can write code like:

>>> from myapp.models import MyModel
>>> instance = MyModel.objects.get(pk=1)
>>> instance.file.size

Assign a file object on assignment so you can do:

>>> with open('/path/to/hello.world') as f:
...     instance.file = File(f)

custom_domain: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_admission: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_from: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_to: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

datetime_from

The localised datetime of the event start date.

Return type:: datetime

datetime_to

The localised datetime of the event end date.

Return type:: datetime

decode_token(token, allow_raise=False)

delete_all_orders(really=False)

delete_sub_objects()

device_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

disable_plugin(module)

display_settings: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

domain: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

domains

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

duration

email: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

email_queue

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

enable_plugin(module, allow_restricted=False)

event

event_grants

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

exhibitors

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

external_auth_url: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

extra_links

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

feature_flags: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

featured_sessions_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

geo_lat: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

geo_lon: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_all_permissions(user)

get_cache(): Returns an ObjectRelatedCache object. This behaves equivalent to Django’s built-in cache backends, but puts you into an isolated environment for this event, so you don’t have to prefix your cache keys. In addition, the cache is being cleared every time the event or one of its related objects change.

Deprecated since version 1.9: Use the property cache instead.

get_currency_display(*, field=<django.db.models.fields.CharField: currency>)

get_data_shredders() → dict: Returns a dictionary of initialized data shredders mapped by their identifiers.

get_feature_flag(feature)

get_html_mail_renderer(): Returns the currently selected HTML email renderer

get_html_mail_renderers() → dict: Returns a dictionary of initialized HTML email renderers mapped by their identifiers.

get_invoice_renderers() → dict: Returns a dictionary of initialized invoice renderers mapped by their identifiers.

get_locale_display(*, field=<django.db.models.fields.CharField: locale>)

get_mail_backend(timeout=None, force_custom=False): Returns an email server connection, either by using the system-wide connection or by returning a custom one based on the event’s settings.

get_mail_template(role)

get_next_by_date_from(*, field=<django.db.models.fields.DateTimeField: date_from>, is_next=True, **kwargs)

get_next_by_date_to(*, field=<django.db.models.fields.DateTimeField: date_to>, is_next=True, **kwargs)

get_payment_providers(cached=False) → dict: Returns a dictionary of initialized payment providers mapped by their identifiers.

get_plugins(): Returns the names of the plugins activated for this event as a list.

get_previous_by_date_from(*, field=<django.db.models.fields.DateTimeField: date_from>, is_next=False, **kwargs)

get_previous_by_date_to(*, field=<django.db.models.fields.DateTimeField: date_to>, is_next=False, **kwargs)

get_timezone_display(*, field=<django.db.models.fields.CharField: timezone>)

get_users_with_any_permission()

Returns a queryset of users who have any permission to this event.

Returns:: Iterable of User

get_users_with_permission(permission)

Returns a queryset of users who have a specific permission to this event.

Returns:: Iterable of User

property has_paid_things

property has_payment_provider

has_permission(*, user, permission: Permission, room=None): Returns whether a user holds a given permission either on the world or on a specific room. permission can be one Permission or a list of these, in which case it will perform an OR lookup.

async has_permission_async(*, user, permission: Permission, room=None): Returns whether a user holds a given permission either on the world or on a specific room. permission can be one Permission or a list of these, in which case it will perform an OR lookup.

has_permission_implicit(*, traits, permissions: List[Permission], room=None, allow_empty_traits=True)

has_subevents: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

header_image: Just like the FileDescriptor, but for ImageFields. The only difference is assigning the width/height to the width_field/height_field, if appropriate.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property invoice_renderer: Returns the currently configured invoice renderer.

invoice_vouchers

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

invoices

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_multilingual: Is True if the event supports more than one locale.

is_public: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_video_creation: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

janusserver_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

landing_page_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

live: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

live_issues

locale: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

locale_array: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

locales: Is a list of active event locales.

location: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

lock(): Returns a contextmanager that can be used to lock an event for bookings.

log_entries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

logentry_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

logo: Just like the FileDescriptor, but for ImageFields. The only difference is assigning the width/height to the width_field/height_field, if appropriate.

mail_settings: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

mail_templates

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property meta_data

meta_values

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

named_content_locales

named_locales: Is a list of tuples of locale codes and natural names for this event.

named_plugin_locales

notification_settings

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

objects = <django.db.models.manager.Manager object>

orders

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

organizer

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

organizer_id

property payment_term_last: The last datetime of payments for this event.

pending_mails

The amount of currently unsent.

QueuedMail objects.

planned_usages

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property plugin_list: list

plugin_locales

plugins: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

posters

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

presale_end: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property presale_has_ended: Is true, when presale_end is set and in the past.

presale_start: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

primary_color: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

product_meta_properties

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

products

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

questions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

queued_mails

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

quotas

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

release_schedule(name: str, user=None, notify_speakers: bool = False, comment: str = None)

Releases a new Schedule by finalising the current WIP schedule.

Parameters:

name – The new version name
user (User) – The User executing the release
notify_speakers – Generate emails for all speakers with changed slots.
comment – Public comment for the release

reorder_review_phases(): Reorder the review phases by start date.

requiredaction_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

review_phases

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

review_settings: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

reviewers

reviews

revoked_secrets

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

roles: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

room_grants

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

rooms

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

sales_channels: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

schedules

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

score_categories

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

seat_category_mappings

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

seating_plan

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

seating_plan_id

seats

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

set_active_plugins(modules, allow_restricted=False)

set_defaults(): This will be called after event creation, but only if the event was not created by copying an existing one. This way, we can use this to introduce new default settings to eventyay that do not affect existing events.

set_plugins(modules: list) → None: This method is not @plugin_list.setter to make the side effects more visible. It will call installed() on all plugins that were not active before, and uninstalled() on all plugins that are not active anymore.

property settings

settings_namespace = 'event'

short_tokens

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

slug: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property social_image

speakers

Returns a queryset of all speakers (of type.

User) visible in the current released schedule.

storedfile_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

subevents

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

subevents_annotated(channel)

subevents_sorted(queryset)

submission_types

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

submissions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

submitter_access_codes

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

submitters

Returns a queryset of all User objects who have submitted to this event.

Ignores users who have deleted all of their submissions.

system_logs

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tags

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property talk_dashboard_url

property talk_schedule_url

property talk_session_url

property talk_settings_url

property talk_speaker_url

talkquestions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

talks

Returns a queryset of all.

Submission object in the current released schedule.

tax_rules

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

team_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

teams: Returns all Team objects that concern this event.

testmode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

ticket_layouts

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property ticket_secret_generator: Returns the currently configured ticket secret generator.

ticket_secret_generators: Returns a dictionary of cached initialized ticket secret generators mapped by their identifiers.

timezone: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tracks

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

trait_grants: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

turnserver_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tz

update_language_configuration(*, locales: list[str] | None = None, content_locales: list[str] | None = None, default_locale: str | None = None) → None

update_review_phase()

This method activates the next review phase if the current one is over.

If no review phase is active and if there is a new one to activate.

updated: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

user_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

views

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

visible_primary_color

vouchers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

waitinglistentries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

webhook_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

wip_schedule

Returns the latest unreleased.

Schedule.

Retval:: Schedule

class eventyay.base.models.SubEvent(*args, **kwargs)

Bases: EventMixin, LoggedModel

This model represents a date within an event series.

Parameters:

event (Event) – The event this belongs to
active (bool) – Whether to show the subevent
is_public (bool) – Whether to show the subevent in lists
name (str) – This event’s full title
date_from (datetime) – The datetime this event starts
date_to (datetime) – The datetime this event ends
presale_start (datetime) – No tickets will be sold before this date.
presale_end (datetime) – No tickets will be sold after this date.
location (str) – venue

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

active: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

allow_delete()

cartposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

checkinlist_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

static clean_products(event, products)

static clean_variations(event, variations)

property currency

date_admission: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_from: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date_to: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(*args, **kwargs)

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

frontpage_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

geo_lat: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

geo_lon: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_date_from(*, field=<django.db.models.fields.DateTimeField: date_from>, is_next=True, **kwargs)

get_next_by_date_to(*, field=<django.db.models.fields.DateTimeField: date_to>, is_next=True, **kwargs)

get_next_by_last_modified(*, field=<django.db.models.fields.DateTimeField: last_modified>, is_next=True, **kwargs)

get_previous_by_date_from(*, field=<django.db.models.fields.DateTimeField: date_from>, is_next=False, **kwargs)

get_previous_by_date_to(*, field=<django.db.models.fields.DateTimeField: date_to>, is_next=False, **kwargs)

get_previous_by_last_modified(*, field=<django.db.models.fields.DateTimeField: last_modified>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoiceline_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_public: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

last_modified: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

location: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property meta_data

meta_values

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

orderposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

presale_end: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

presale_start: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

product_overrides

property product_price_overrides

products

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

quotas

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

seat_category_mappings

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

seating_plan

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

seating_plan_id

seats

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

settings

subeventproduct_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

subeventproductvariation_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

var_overrides

property var_price_overrides

variations

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

voucher_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

waitinglistentry_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class eventyay.base.models.Team(*args, **kwargs)

Bases: LoggedModel, TimestampedModel, RulesModelMixin, Model

A team is a collection of people given certain access rights to one or more events of an organizer.

Parameters:

name (str) – The name of this team
organizer (Organizer) – The organizer this team belongs to
members – A set of users who belong to this team
all_events (bool) – Whether this team has access to all events of this organizer
limit_events – A set of events this team has access to. Irrelevant if all_events is True.
can_create_events (bool) – Whether or not the members can create new events with this organizer account.
can_change_teams (bool) – If True, the members can change the teams of this organizer account.
can_change_organizer_settings (bool) – If True, the members can change the settings of this organizer account.
can_change_event_settings (bool) – If True, the members can change the settings of the associated events.
can_change_items (bool) – If True, the members can change and add items and related objects for the associated events.
can_view_orders (bool) – If True, the members can inspect details of all orders of the associated events.
can_change_orders (bool) – If True, the members can change details of orders of the associated events.
can_checkin_orders (bool) – If True, the members can perform check-in related actions.
can_view_vouchers (bool) – If True, the members can inspect details of all vouchers of the associated events.
can_change_vouchers (bool) – If True, the members can change and create vouchers for the associated events.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

property active_tokens

all_events: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_change_event_settings: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_change_items: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_change_orders: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_change_organizer_settings: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property can_change_settings

can_change_submissions: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_change_teams: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_change_vouchers: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_checkin_orders: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_create_events: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_manage_gift_cards: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_view_orders: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

can_view_vouchers: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

events

force_hide_speaker_names: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

has_permission(perm_name)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invites

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_reviewer: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

limit_events

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

limit_tracks

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

members

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

organizer

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

organizer_id

permission_for_event(event)

permission_set() → set

permission_set_display: The same as permission_set(), but with human-readable names.

tokens

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

updated: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.TeamAPIToken(*args, **kwargs)

Bases: Model

A TeamAPIToken represents an API token that has the same access level as the team it belongs to.

Parameters:

team (Team) – The team the person is invited to
name (str) – A human-readable name for the token
active (bool) – Whether or not this token is active
token (str) – The secret required to submit to the API

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

active: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_event_permission_set(organizer, event) → set

Gets a set of permissions (as strings) that a token holds for a particular event

Parameters:

organizer – The organizer of the event
event – The event to check

Returns:

set of permissions

get_events_with_any_permission()

Returns a queryset of events the token has any permissions to.

Returns:: Iterable of Events

get_events_with_permission(permission, request=None)

Returns a queryset of events the token has a specific permissions to.

Parameters:: request – Ignored, for compatibility with User model
Returns:: Iterable of Events

get_organizer_permission_set(organizer) → set

Gets a set of permissions (as strings) that a token holds for a particular organizer

Parameters:: organizer – The organizer of the event
Returns:: set of permissions

has_event_permission(organizer, event, perm_name=None, request=None) → bool

Checks if this token is part of a team that grants access of type perm_name to the event event.

Parameters:

organizer – The organizer of the event
event – The event to check
perm_name – The permission, e.g. can_change_teams
request – This parameter is ignored and only defined for compatibility reasons.

Returns:

bool

has_organizer_permission(organizer, perm_name=None, request=None)

Checks if this token is part of a team that grants access of type perm_name to the organizer organizer.

Parameters:

organizer – The organizer to check
perm_name – The permission, e.g. can_change_teams
request – This parameter is ignored and only defined for compatibility reasons.

Returns:

bool

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

logentry_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

team

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

team_id

token: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.RequiredAction(*args, **kwargs)

Bases: Model

Represents an action that is to be done by an admin. The admin will be displayed a list of actions to do.

Parameters:

datatime – The timestamp of the required action
user (User) – The user that performed the action
done (bool) – If this action has been completed or dismissed
action_type (str) – The type of action that has to be performed. This is used to look up the renderer used to describe the action in a human- readable way. This should be some namespaced value using dotted notation to avoid duplicates, e.g. "eventyay.plugins.banktransfer.incoming_transfer".
data (str) – Arbitrary data that can be used by the log action renderer

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

action_type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

data: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

datetime: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

display(request)

done: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

get_next_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=True, **kwargs)

get_previous_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id

class eventyay.base.models.EventMetaProperty(*args, **kwargs)

Bases: LoggedModel

An organizer account can have EventMetaProperty objects attached to define meta information fields for its events. This information can be re-used for example in ticket layouts.

Parameters:

organizer (Organizer) – The organizer this property is defined for.
name (Name of the property, used in various places) – Name
default (str) – Default value

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

allowed_values: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

default: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event_values

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

full_clean(exclude=None, validate_unique=True): Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

organizer

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

organizer_id

protected: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

required: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

subevent_values

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class eventyay.base.models.EventMetaValue(*args, **kwargs)

Bases: LoggedModel

A meta-data value assigned to an event.

Parameters:

event (Event) – The event this metadata is valid for
property (EventMetaProperty) – The property this value belongs to
value (str) – The actual value

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

delete(*args, **kwargs)

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

property

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

property_id

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.SubEventMetaValue(*args, **kwargs)

Bases: LoggedModel

A meta-data value assigned to a sub-event.

Parameters:

event (Event) – The event this metadata is valid for
property (EventMetaProperty) – The property this value belongs to
value (str) – The actual value

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

delete(*args, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

property

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

property_id

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

subevent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

subevent_id

value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

Products

class eventyay.base.models.Product(*args, **kwargs)

Bases: LoggedModel

An product is a thing which can be sold. It belongs to an event and may or may not belong to a category. Product was previously named ‘Item’ or referenced as ‘items’ internally due to historic reasons.

Parameters:

event (Event) – The event this product belongs to
category (ProductCategory) – The category this belongs to. May be null.
name (str) – The name of this product
active (bool) – Whether this product is being sold.
description (str) – A short description
default_price (decimal.Decimal) – The product’s default price
tax_rate (decimal.Decimal) – The VAT tax that is included in this product’s price (in %)
admission (bool) – True, if this product allows persons to enter the event (as opposed to e.g. merchandise)
picture (File) – A product picture to be shown next to the product description
available_from (datetime) – The date this product goes on sale
available_until (datetime) – The date until when the product is on sale
require_voucher (bool) – If set to True, this product can only be bought using a voucher.
hide_without_voucher (bool) – If set to True, this product is only visible and available when a voucher is used.
allow_cancel (bool) – If set to False, an order with this product can not be canceled by the user.
max_per_order (int) – Maximum number of times this product can be in an order. None for unlimited.
min_per_order (int) – Minimum number of times this product needs to be in an order if bought at all. None for unlimited.
checkin_attention (bool) – Requires special attention at check-in
original_price (decimal.Decimal) – The product’s “original” price. Will not be used for any calculations, will just be shown.
require_approval (bool) – If set to True, orders containing this product can only be processed and paid after approval by an administrator
sales_channels (bool) – Sales channels this product is available on.
issue_giftcard (bool) – If True, buying this product will give you a gift card with the value of the product’s price

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

active: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

addons

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

admission: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

allow_cancel: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

allow_delete()

allow_waitinglist: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

available_from: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

available_until: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

badge_assignment

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

bundled_with

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

bundles

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

cartposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

category

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

category_id

check_quotas(ignored_quotas=None, count_waitinglist=True, subevent=None, _cache=None, include_bundled=False, trust_parameters=False, fail_on_no_quotas=False)

This method is used to determine whether this Product is currently available for sale.

Parameters:

ignored_quotas – If a collection if quota objects is given here, those quotas will be ignored in the calculation. If this leads to no quotas being checked at all, this method will return unlimited availability.
include_bundled – Also take availability of bundled products into consideration.
trust_parameters – Disable checking of the subevent parameter and disable checking if any variations exist (performance optimization).

Returns:

any of the return codes of Quota.availability().

Raises:

ValueError – if you call this on an product which has variations associated with it. Please use the method on the ProductVariation object you are interested in.

checkin_attention: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

checkinlist_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

static clean_available(from_date, until_date)

static clean_category(category, event)

static clean_per_order(min_per_order, max_per_order)

static clean_tax_rule(tax_rule, event)

default_price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(*args, **kwargs)

description: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property do_show_quota_left

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

free_price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

generate_tickets: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

has_variations

hidden_if_available

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

hidden_if_available_id

hide_without_voucher: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property includes_mixed_tax_rate

internal_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoiceline_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_available(now_dt: datetime = None) → bool: Returns whether this product is available according to its active flag and its available_from and available_until fields

is_available_by_time(now_dt: datetime = None) → bool

issue_giftcard: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

max_per_order: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property meta_data

meta_values

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

min_per_order: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <eventyay.base.models.product.ProductQuerySetManager object>

orderposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

original_price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

picture: Just like the FileDescriptor, but for ImageFields. The only difference is assigning the width/height to the width_field/height_field, if appropriate.

position: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

questions

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

quotas

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

require_approval: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

require_bundling: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

require_voucher: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

sales_channels: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

seat_category_mappings

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

seats

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

show_quota_left: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

subevent_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

subeventproduct_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tax(price=None, base_price_is='auto', currency=None, invoice_address=None, override_tax_rate=None, include_bundled=False)

tax_rule

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

tax_rule_id

ticketlayout_assignments

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

variations

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

vouchers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

waitinglistentries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class eventyay.base.models.ProductCategory(*args, **kwargs)

Bases: LoggedModel

Products can be sorted into these categories.

Parameters:

event (Event) – The event this category belongs to
name (str) – The name of this category
position (int) – An integer, used for sorting

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

addon_to

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

delete(*args, **kwargs)

description: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

internal_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_addon: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

position: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

products

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

property sortkey

class eventyay.base.models.ProductVariation(*args, **kwargs)

Bases: Model

A variation of a product. For example, if your product is ‘T-Shirt’ then an example for a variation would be ‘T-Shirt XL’.

Parameters:

product (Product) – The product this variation belongs to
value (str) – A string defining this variation
description (str) – A short description
active (bool) – Whether this variation is being sold.
default_price (decimal.Decimal) – This variation’s default price
original_price (decimal.Decimal) – The product’s “original” price. Will not be used for any calculations, will just be shown.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

active: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

allow_delete()

bundled_with

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

cartposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

check_quotas(ignored_quotas=None, count_waitinglist=True, subevent=None, _cache=None, include_bundled=False, trust_parameters=False, fail_on_no_quotas=False) → Tuple[int, int]

This method is used to determine whether this ProductVariation is currently available for sale in terms of quotas.

Parameters:

ignored_quotas – If a collection if quota objects is given here, those quotas will be ignored in the calculation. If this leads to no quotas being checked at all, this method will return unlimited availability.
count_waitinglist – If False, waiting list entries will be ignored for quota calculation.

Returns:

any of the return codes of Quota.availability().

default_price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(*args, **kwargs)

description: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoiceline_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

is_only_variation()

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

orderposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

original_price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

position: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property price

product

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

product_id

quotas

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

subevent_set

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

subeventproductvariation_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

tax(price=None, base_price_is='auto', currency=None, include_bundled=False, override_tax_rate=None, invoice_address=None)

value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

vouchers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

waitinglistentries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class eventyay.base.models.ProductAddOn(*args, **kwargs)

Bases: Model

An instance of this model indicates that buying a ticket of the time base_product allows you to add up to max_count products from the category addon_category to your order that will be associated with the base product.

Parameters:

base_product (Product) – The base product the add-ons are attached to
addon_category (ProductCategory) – The category the add-on can be chosen from
min_count (int) – The minimal number of add-ons to be chosen
max_count (int) – The maximal number of add-ons to be chosen
position (int) – An integer used for sorting

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

addon_category

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

addon_category_id

base_product

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

base_product_id

clean(): Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

static clean_categories(event, product, addon, new_category)

static clean_max_count(max_count)

static clean_max_min_count(max_count, min_count)

static clean_min_count(min_count)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

max_count: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

min_count: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

multi_allowed: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>

position: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

price_included: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.Question(*args, **kwargs)

Bases: LoggedModel

A question is an input field that can be used to extend a ticket by custom information, e.g. “Attendee age”. The answers are found next to the position. The answers may be found in QuestionAnswers, attached to OrderPositions/CartPositions. A question can allow one of several input types, currently:

a number (TYPE_NUMBER)
a one-line string (TYPE_STRING)
a multi-line string (TYPE_TEXT)
a boolean (TYPE_BOOLEAN)
a multiple choice option (TYPE_CHOICE and TYPE_CHOICE_MULTIPLE)
a file upload (TYPE_FILE)
a date (TYPE_DATE)
a time (TYPE_TIME)
a date and a time (TYPE_DATETIME)

Parameters:

event (Event) – The event this question belongs to
question (str) – The question text. This will be displayed next to the input field.
type – One of the above types
required (bool) – Whether answering this question is required for submitting an order including products associated with this question.
products – A set of Products objects that this question should be applied to
ask_during_checkin (bool) – Whether to ask this question during check-in instead of during check-out.
hidden (bool) – Whether to only show the question in the backend
identifier (str) – An arbitrary, internal identifier
dependency_question (Question) – This question will only show up if the referenced question is set to dependency_value.
dependency_values (list[str]) – The values that dependency_question needs to be set to for this question to be applicable.

ASK_DURING_CHECKIN_UNSUPPORTED = ['TEL']

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

TYPE_BOOLEAN = 'B'

TYPE_CHOICE = 'C'

TYPE_CHOICES = (('N', 'Number'), ('S', 'Text (one line)'), ('T', 'Multiline text'), ('B', 'Confirm Checkbox'), ('C', 'Radio button (Choose one option)'), ('M', 'Checkbox (Choose one or several options)'), ('F', 'File upload'), ('D', 'Date'), ('H', 'Time'), ('W', 'Date and time'), ('CC', 'Country code (ISO 3166-1 alpha-2)'), ('TEL', 'Phone number'), ('DES', 'Text field'))

TYPE_CHOICE_MULTIPLE = 'M'

TYPE_COUNTRYCODE = 'CC'

TYPE_DATE = 'D'

TYPE_DATETIME = 'W'

TYPE_DESCRIPTION = 'DES'

TYPE_FILE = 'F'

TYPE_NUMBER = 'N'

TYPE_PHONENUMBER = 'TEL'

TYPE_STRING = 'S'

TYPE_TEXT = 'T'

TYPE_TIME = 'H'

UNLOCALIZED_TYPES = ['D', 'H', 'W']

answers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

ask_during_checkin: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

clean_answer(answer)

clean_identifier(code)

static clean_products(event, products)

delete(*args, **kwargs)

dependency_question

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

dependency_question_id

dependency_values: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

dependent_questions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

description: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

get_type_display(*, field=<django.db.models.fields.CharField: type>)

help_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

hidden: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

identifier: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

options

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

position: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

print_on_invoice: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

products

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

question: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

required: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

property sortkey

type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

valid_date_max: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

valid_date_min: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

valid_datetime_max: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

valid_datetime_min: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

valid_number_max: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

valid_number_min: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.Quota(*args, **kwargs)

Bases: LoggedModel

A quota is a “pool of tickets”. It is there to limit the number of products of a certain type to be sold. For example, you could have a quota of 500 applied to all of your products (because you only have that much space in your venue), and also a quota of 100 applied to the VIP tickets for exclusivity. In this case, no more than 500 tickets will be sold in total and no more than 100 of them will be VIP tickets (but 450 normal and 50 VIP tickets will be fine).

As always, a quota can not only be tied to an product, but also to specific variations.

Please read the documentation section on quotas carefully before doing anything with quotas. This might confuse you otherwise.

The AVAILABILITY_* constants represent various states of a quota allowing its products/variations to be up for sale.

AVAILABILITY_OK: This product is available for sale.
AVAILABILITY_RESERVED: This product is currently not available for sale because all available products are in people’s shopping carts. It might become available again if those people do not proceed to the checkout.
AVAILABILITY_ORDERED: This product is currently not available for sale because all available products are ordered. It might become available again if those people do not pay.
AVAILABILITY_GONE: This product is completely sold out.

Parameters:

event (Event) – The event this belongs to
subevent (SubEvent) – The event series date this belongs to, if event series are enabled
name (str) – This quota’s name
size (int) – The number of products in this quota
products – The set of Product objects this quota applies to
variations – The set of ProductVariation objects this quota applies to

This model keeps a cache of the quota availability that is used in places where up-to-date data is not important. This cache might be out of date even though a more recent quota was calculated. This is intentional to keep database writes low. Currently, the cached values are written whenever the quota is being calculated throughout the system and the cache is at least 120 seconds old or if the new value is qualitatively “better” than the cached one (i.e. more free quota).

There’s also a cronjob that refreshes the cache of every quota if there is any log entry in the event that is newer than the quota’s cached time.

AVAILABILITY_GONE = 0

AVAILABILITY_OK = 100

AVAILABILITY_ORDERED = 10

AVAILABILITY_RESERVED = 20

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

exception QuotaExceededException: Bases: Exception

availability(now_dt: datetime = None, count_waitinglist=True, _cache=None, allow_cache=False) → Tuple[int, int]

This method is used to determine whether Products or ProductVariations belonging to this quota should currently be available for sale.

Parameters:

count_waitinglist – Whether or not take waiting list reservations into account. Defaults to True.
_cache – A dictionary mapping quota IDs to availabilities. If this quota is already contained in that dictionary, this value will be used. Otherwise, the dict will be populated accordingly.
allow_cache – Allow for values to be returned from the longer-term cache, see also the documentation of this model class. Only works if count_waitinglist is set to True.

Returns:

a tuple where the first entry is one of the Quota.AVAILABILITY_ constants and the second is the number of available tickets.

static clean_products(event, products, variations)

static clean_subevent(event, subevent)

static clean_variations(products, variations)

close_when_sold_out: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

closed: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(*args, **kwargs)

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

product_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

products

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

rebuild_cache(now_dt=None)

release_after_exit: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

size: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

subevent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

subevent_id

variations

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

vouchers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

Carts and Orders

class eventyay.base.models.Order(*args, **kwargs)

Bases: LockModel, LoggedModel

An order is created when a user clicks ‘buy’ on his cart. It holds several OrderPositions and is connected to a user. It has an expiration date: If products run out of capacity, orders which are over their expiration date might be canceled.

An order – like all objects – has an ID, which is globally unique, but also a code, which is shorter and easier to memorize, but only unique within a single conference.

Parameters:

code (str) – In addition to the ID, which is globally unique, every order has an order code, which is shorter and easier to memorize, but is only unique within a single conference.
status –
The status of this order. One of:
- STATUS_PENDING
- STATUS_PAID
- STATUS_EXPIRED
- STATUS_CANCELED
event (Event) – The event this order belongs to
email (str) – The email of the person who ordered this
phone (str) – The phone number of the person who ordered this
testmode (bool) – Whether this is a test mode order
locale (str) – The locale of this order
secret (str) – A secret string that is required to modify the order
datetime (datetime) – The datetime of the order placement
expires (datetime) – The date until this order has to be paid to guarantee the fulfillment
total (decimal.Decimal) – The total amount of the order, including the payment fee
comment (str) – An internal comment that will only be visible to staff, and never displayed to the user
download_reminder_sent (boolean) – A field to indicate whether a download reminder has been sent.
require_approval (bool) – If set to True, this order is pending approval by an organizer
meta_info (str) – Additional meta information on the order, JSON-encoded.
sales_channel (str) – Identifier of the sales channel this order was created through.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

STATUS_CANCELED = 'c'

STATUS_CHOICE = (('n', 'pending'), ('p', 'paid'), ('e', 'expired'), ('c', 'canceled'))

STATUS_EXPIRED = 'e'

STATUS_PAID = 'p'

STATUS_PENDING = 'n'

STATUS_REFUNDED = 'c'

all_fees

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

all_positions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

classmethod annotate_overpayments(qs, results=True, refunds=True, sums=False)

assign_code()

banktransaction_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

cachedcombinedticket_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property can_modify_answers: bool: True if the user can change the question answers / attendee names that are related to the order. This checks order status and modification deadlines. It also returns False if there are no questions that can be answered.

cancel_allowed()

cancellation_date: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

cancellation_requests

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property changable

checkin_attention: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

code: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

comment: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

count_positions

datetime: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

download_reminder_sent: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

email: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

email_confirm_hash()

email_known_to_work: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

expires: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

expiry_reminder_sent: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property fees: Related manager for all non-canceled fees. Use all_fees instead if you want canceled positions as well.

property full_code: An order code which is unique among all events of a single organizer, built by concatenating the event slug and the order code.

get_next_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=True, **kwargs)

get_next_by_expires(*, field=<django.db.models.fields.DateTimeField: expires>, is_next=True, **kwargs)

get_next_by_last_modified(*, field=<django.db.models.fields.DateTimeField: last_modified>, is_next=True, **kwargs)

get_previous_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=False, **kwargs)

get_previous_by_expires(*, field=<django.db.models.fields.DateTimeField: expires>, is_next=False, **kwargs)

get_previous_by_last_modified(*, field=<django.db.models.fields.DateTimeField: last_modified>, is_next=False, **kwargs)

get_status_display(*, field=<django.db.models.fields.CharField: status>)

gift_card_transactions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

gracefully_delete(user=None, auth=None)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_address

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

invoices

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property is_expired_by_time

is_modification_allowed_by(email: str) → bool: Returns True if a user with this email is allowed to modify the order, based on the event’s ‘allow_modifications’ setting.

last_modified: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

locale: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

meta_info: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

meta_info_data

modify_deadline()

property net_total

static normalize_code(code, is_fallback=False)

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

property payment_refund_sum

property payment_term_last

payments

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

property pending_sum

phone

The descriptor for the phone number attribute on the model instance. Returns a PhoneNumber when accessed so you can do stuff like:

>>> instance.phone_number.as_international

Assigns a phone number object on assignment so you can do:

>>> instance.phone_number = PhoneNumber(...)

or,

>>> instance.phone_number = '+414204242'

property positions: Related manager for all non-canceled positions. Use all_positions instead if you want canceled positions as well.

property positions_with_tickets

propose_auto_refunds(amount: Decimal, payments: list = None)

refunds

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

require_approval: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

resend_link(user=None, auth=None)

sales_channel: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(**kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

secret: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

send_mail(subject: str, template: str | LazyI18nString, context: Dict[str, Any] = None, log_entry_type: str = 'eventyay.event.order.email.sent', user: User = None, headers: dict = None, sender: str = None, invoices: list = None, auth=None, attach_tickets=False, position: OrderPosition = None, auto_email=True, attach_ical=False)

Sends an email to the user that placed this order. Basically, this method does two things:

Call eventyay.base.services.mail.mail with useful values for the event, locale, recipient and order parameters.
Create a LogEntry with the email contents.

Parameters:

subject – Subject of the email
template – LazyI18nString or template filename, see eventyay.base.services.mail.mail for more details
context – Dictionary to use for rendering the template
log_entry_type – Key to be used for the log entry
user – Administrative user who triggered this mail to be sent
headers – Dictionary with additional mail headers
sender – Custom email sender.
attach_tickets – Attach tickets of this order, if they are existing and ready to download
attach_ical – Attach relevant ICS files
position – An order position this refers to. If given, no invoices will be attached, the tickets will only be attached for this position and child positions, the link will only point to the position and the attendee email will be used if available.

set_expires(now_dt=None, subevents=None)

status: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tagged_secret(tag, secret_length=64)

tax_total

testmode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property ticket_download_available

property ticket_download_date: Returns the first date the tickets for this order can be downloaded or None if there is no restriction.

total: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

touch()

property user_cancel_allowed: bool: Returns whether or not this order can be canceled by the user.

user_cancel_deadline

user_cancel_fee

property user_change_allowed: bool: Returns whether or not this order can be canceled by the user.

user_change_deadline

classmethod user_has_existing_order(event, email)

Check if a user (identified by email) already has an existing order for the event.

Args:: event: The event to check email: The user’s email address
Returns:: bool: True if user has existing order, False otherwise

class eventyay.base.models.AbstractPosition(*args, **kwargs)

Bases: Model

A position can either be one line of an order or an product placed in a cart.

Parameters:

subevent (SubEvent) – The date in the event series, if event series are enabled
product (Product) – The selected product
variation (ProductVariation) – The selected ProductVariation or null, if the product has no variations
datetime (datetime) – The datetime this product was put into the cart
expires (datetime) – The date until this product is guaranteed to be reserved
price (decimal.Decimal) – The price of this product
attendee_name_parts (str) – The parts of the attendee’s name, if entered.
attendee_name_cached (str) – The concatenated version of the attendee’s name, if entered.
attendee_email (str) – The attendee’s email, if entered.
voucher (Voucher) – A voucher that has been applied to this sale
meta_info (str) – Additional meta information on the position, JSON-encoded.
seat (Seat) – Seat, if reserved seating is used.

class Meta

Bases: object

abstract = False

addon_to

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

addon_to_id

address_format()

attendee_email: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property attendee_name

attendee_name_cached: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

attendee_name_parts: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

cache_answers(all=True): Creates two properties on the object. (1) answ: a dictionary of question.id → answer string (2) questions: a list of Question objects, extended by an ‘answer’ property

city: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

company: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

country

A descriptor for country fields on a model instance. Returns a Country when accessed so you can do things like:

>>> from people import Person
>>> person = Person.object.get(name='Chris')

>>> person.country.name
'New Zealand'

>>> person.country.flag
'/static/flags/nz.gif'

get_country_display(*, field=<eventyay.helpers.countries.FastCountryField: country>)

job_title: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

meta_info: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property meta_info_data

property net_price

price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

price_before_voucher: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

product

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

product_id

property quotas

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

seat

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

seat_id

state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property state_for_address

property state_name

street: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

subevent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

subevent_id

variation

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

variation_id

voucher

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

voucher_id

zipcode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.OrderPosition(*args, **kwargs)

Bases: AbstractPosition

An OrderPosition is one line of an order, representing one ordered product of a specified type (or variation). This has all properties of AbstractPosition.

The default OrderPosition.objects manager only contains fees that are not canceled. If you ant all objects, you need to use OrderPosition.all instead.

Parameters:

order (Order) – The order this position is a part of
positionid (int) – A local ID of this position, counted for each order individually
tax_rate (Decimal) – The tax rate applied to this position
tax_rule (TaxRule) – The tax rule applied to this position
tax_value (Decimal) – The tax amount included in the price
secret (str) – The secret used for ticket QR codes
canceled (bool) – True, if this position is canceled and should no longer be regarded
pseudonymization_id (str) – The QR code content for lead scanning

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

addon_to

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

addon_to_id

addons

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

all = <django_scopes.manager.ScopedManager.<locals>.Manager object>

answers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

assign_pseudonymization_id()

attendee_email: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

attendee_name_cached: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

attendee_name_parts: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

cachedticket_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

canceled: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

checkins

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

city: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

company: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

country

A descriptor for country fields on a model instance. Returns a Country when accessed so you can do things like:

>>> from people import Person
>>> person = Person.object.get(name='Chris')

>>> person.country.name
'New Zealand'

>>> person.country.flag
'/static/flags/nz.gif'

property event

property generate_ticket

get_country_display(*, field=<eventyay.helpers.countries.FastCountryField: country>)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

issued_gift_cards

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

job_title: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

meta_info: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <eventyay.base.models.orders.ActivePositionManager object>

order

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

order_id

positionid: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

price_before_voucher: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

product

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

product_id

pseudonymization_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

require_checkin_attention

resend_link(user=None, auth=None)

revoked_secrets

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

seat

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

seat_id

secret: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

send_mail(subject: str, template: str | LazyI18nString, context: Dict[str, Any] = None, log_entry_type: str = 'eventyay.event.order.email.sent', user: User = None, headers: dict = None, sender: str = None, invoices: list = None, auth=None, attach_tickets=False)

Sends an email to the attendee. Basically, this method does two things:

Call eventyay.base.services.mail.mail with useful values for the event, locale, recipient and order parameters.
Create a LogEntry with the email contents.

Parameters:

subject – Subject of the email
template – LazyI18nString or template filename, see eventyay.base.services.mail.mail for more details
context – Dictionary to use for rendering the template
log_entry_type – Key to be used for the log entry
user – Administrative user who triggered this mail to be sent
headers – Dictionary with additional mail headers
sender – Custom email sender.
attach_tickets – Attach tickets of this order, if they are existing and ready to download

sort_key

state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

street: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

subevent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

subevent_id

tax_rate: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tax_rule

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

tax_rule_id

tax_value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

classmethod transform_cart_positions(cp: List, order) → list

variation

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

variation_id

voucher

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

voucher_id

web_secret: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

zipcode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.OrderFee(*args, **kwargs)

Bases: Model

An OrderFee object represents a fee that is added to the order total independently of the actual positions. This might for example be a payment or a shipping fee.

The default OrderFee.objects manager only contains fees that are not canceled. If you ant all objects, you need to use OrderFee.all instead.

Parameters:

value (Decimal) – Gross price of this fee
order (Order) – Order this fee is charged with
fee_type (str) – The type of the fee, currently payment, shipping, service, giftcard, or other.
description (str) – A human-readable description of the fee
internal_type (str) – An internal string to group fees by, e.g. the identifier string of a payment provider
tax_rate (Decimal) – The tax rate applied to this fee
tax_rule (TaxRule) – The tax rule applied to this fee
tax_value (Decimal) – The tax amount included in the price
canceled (bool) – True, if this position is canceled and should no longer be regarded

exception DoesNotExist: Bases: ObjectDoesNotExist

FEE_TYPES = (('payment', 'Payment fee'), ('shipping', 'Shipping fee'), ('service', 'Service fee'), ('cancellation', 'Cancellation fee'), ('other', 'Other fees'), ('giftcard', 'Gift card'))

FEE_TYPE_CANCELLATION = 'cancellation'

FEE_TYPE_GIFTCARD = 'giftcard'

FEE_TYPE_OTHER = 'other'

FEE_TYPE_PAYMENT = 'payment'

FEE_TYPE_SERVICE = 'service'

FEE_TYPE_SHIPPING = 'shipping'

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

all = <django_scopes.manager.ScopedManager.<locals>.Manager object>

canceled: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(**kwargs)

description: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

fee_type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_fee_type_display(*, field=<django.db.models.fields.CharField: fee_type>)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

internal_type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property net_value

objects = <eventyay.base.models.orders.ActivePositionManager object>

order

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

order_id

payments

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

tax_rate: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tax_rule

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

tax_rule_id

tax_value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.OrderPayment(*args, **kwargs)

Bases: Model

Represents a payment or payment attempt for an order.

Parameters:

id – A globally unique ID for this payment
local_id (int) – An ID of this payment, counting from one for every order independently.
state (str) – The state of the payment, one of created, pending, confirmed, failed, canceled, or refunded.
amount (Decimal) – The payment amount
order (Order) – The order that is paid
created (datetime) – The creation time of this record
payment_date (datetime) – The completion time of this payment
provider (str) – The payment provider in use
info (str) – Provider-specific meta information (in JSON format)
fee (eventyay.base.models.OrderFee) – The OrderFee object used to track the fee for this order.

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

PAYMENT_STATES = (('created', 'created'), ('pending', 'pending'), ('confirmed', 'confirmed'), ('canceled', 'canceled'), ('failed', 'failed'), ('refunded', 'refunded'))

PAYMENT_STATE_CANCELED = 'canceled'

PAYMENT_STATE_CONFIRMED = 'confirmed'

PAYMENT_STATE_CREATED = 'created'

PAYMENT_STATE_FAILED = 'failed'

PAYMENT_STATE_PENDING = 'pending'

PAYMENT_STATE_REFUNDED = 'refunded'

amount: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

confirm(count_waitinglist=True, send_mail=True, force=False, user=None, auth=None, mail_text='', ignore_date=False, lock=True, payment_date=None)

Marks the payment as complete. If possible, this also marks the order as paid if no further payment is required

Parameters:

count_waitinglist (boolean) – Whether, when calculating quota, people on the waiting list should be taken into consideration (default: True).
force (boolean) – Whether this payment should be marked as paid even if no remaining quota is available (default: False).
ignore_date – Whether this order should be marked as paid even when the last date of payments is over.
send_mail (boolean) – Whether an email should be sent to the user about this event (default: True).
user – The user who performed the change
auth – The API auth token that performed the change
mail_text (str) – Additional text to be included in the email

Raises:

Quota.QuotaExceededException – if the quota is exceeded and force is False

create_external_refund(amount=None, execution_date=None, info='{}')

This should be called to create an OrderRefund object when a refund has triggered by an external source, e.g. when a credit card payment has been refunded by the credit card provider.

Parameters:

amount (Decimal) – Amount to refund. If not given, the full payment amount will be used.
execution_date (datetime) – Date of the refund. Defaults to the current time.
info (str) – Additional information, defaults to "{}".

Returns:

OrderRefund

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

fail(info=None, user=None, auth=None): Marks the order as failed and sets info to info, but only if the order is in created or pending state. This is equivalent to setting state to OrderPayment.PAYMENT_STATE_FAILED and logging a failure, but it adds strong database logging since we do not want to report a failure for an order that has just been marked as paid.

fee

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

fee_id

property full_id: The full human-readable ID of this payment, constructed by the order code and the local_id field with -P- in between. :return:

get_next_by_created(*, field=<django.db.models.fields.DateTimeField: created>, is_next=True, **kwargs)

get_previous_by_created(*, field=<django.db.models.fields.DateTimeField: created>, is_next=False, **kwargs)

get_state_display(*, field=<django.db.models.fields.CharField: state>)

gift_card_transactions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

info: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property info_data: This property allows convenient access to the data stored in the info attribute by automatically encoding and decoding the content as JSON.

local_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

migrated: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

order

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

order_id

payment_date: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

payment_provider: Cached access to an instance of the payment provider in use.

provider: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property refunded_amount: The sum of all refund amounts in done, transit, or created states associated with this payment.

refunds

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.OrderRefund(*args, **kwargs)

Bases: Model

Represents a refund or refund attempt for an order.

Parameters:

id – A globally unique ID for this refund
local_id (int) – An ID of this refund, counting from one for every order independently.
state (str) – The state of the refund, one of created, transit, external, canceled, failed, or done.
source – How this refund was started, one of buyer, admin, or external.
amount (Decimal) – The refund amount
order (Order) – The order that is refunded
created (datetime) – The creation time of this record
execution_date (datetime) – The completion time of this refund
provider (str) – The payment provider in use
info (dict) – Provider-specific meta information in JSON format

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

REFUND_SOURCES = (('admin', 'Organizer'), ('buyer', 'Customer'), ('external', 'External'))

REFUND_SOURCE_ADMIN = 'admin'

REFUND_SOURCE_BUYER = 'buyer'

REFUND_SOURCE_EXTERNAL = 'external'

REFUND_STATES = (('external', 'started externally'), ('created', 'created'), ('transit', 'in transit'), ('done', 'done'), ('failed', 'failed'), ('canceled', 'canceled'))

REFUND_STATE_CANCELED = 'canceled'

REFUND_STATE_CREATED = 'created'

REFUND_STATE_DONE = 'done'

REFUND_STATE_EXTERNAL = 'external'

REFUND_STATE_FAILED = 'failed'

REFUND_STATE_TRANSIT = 'transit'

amount: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

comment: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

created: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

done(user=None, auth=None)

Marks the refund as complete. This does not modify the state of the order.

Parameters:

user – The user who performed the change
auth – The API auth token that performed the change

execution_date: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property full_id: The full human-readable ID of this refund, constructed by the order code and the local_id field with -R- in between. :return:

get_next_by_created(*, field=<django.db.models.fields.DateTimeField: created>, is_next=True, **kwargs)

get_previous_by_created(*, field=<django.db.models.fields.DateTimeField: created>, is_next=False, **kwargs)

get_source_display(*, field=<django.db.models.fields.CharField: source>)

get_state_display(*, field=<django.db.models.fields.CharField: state>)

gift_card_transactions

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

info: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property info_data: This property allows convenient access to the data stored in the info attribute by automatically encoding and decoding the content as JSON.

local_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

order

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

order_id

payment

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

payment_id

payment_provider: Cached access to an instance of the payment provider in use.

provider: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

source: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.CartPosition(*args, **kwargs)

Bases: AbstractPosition

A cart position is similar to an order line, except that it is not yet part of a binding order but just placed by some user in his or her cart. It therefore normally has a much shorter expiration time than an ordered position, but still blocks an product in the quota pool as we do not want to throw out users while they’re clicking through the checkout process. This has all properties of AbstractPosition.

Parameters:

event (Event) – The event this belongs to
cart_id (str) – The user session that contains this cart position

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

addon_to

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

addon_to_id

addons

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

answers

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

attendee_email: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

attendee_name_cached: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

attendee_name_parts: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

cart_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

city: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

company: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

country

A descriptor for country fields on a model instance. Returns a Country when accessed so you can do things like:

>>> from people import Person
>>> person = Person.object.get(name='Chris')

>>> person.country.name
'New Zealand'

>>> person.country.flag
'/static/flags/nz.gif'

datetime: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

expires: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_country_display(*, field=<eventyay.helpers.countries.FastCountryField: country>)

get_next_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=True, **kwargs)

get_next_by_expires(*, field=<django.db.models.fields.DateTimeField: expires>, is_next=True, **kwargs)

get_previous_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=False, **kwargs)

get_previous_by_expires(*, field=<django.db.models.fields.DateTimeField: expires>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

includes_tax: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_bundled: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

job_title: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

meta_info: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

override_tax_rate: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

price: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

price_before_voucher: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

product

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

product_id

seat

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

seat_id

state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

street: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

subevent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

subevent_id

property tax_rate

property tax_value

variation

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

variation_id

voucher

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

voucher_id

zipcode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.QuestionAnswer(*args, **kwargs)

Bases: Model

The answer to a Question, connected to an OrderPosition or CartPosition.

Parameters:

orderposition (OrderPosition) – The order position this is related to, or null if this is related to a cart position.
cartposition (CartPosition) – The cart position this is related to, or null if this is related to an order position.
question (Question) – The question this is an answer for
answer (str) – The actual answer data

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

answer: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property backend_file_url

cartposition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

cartposition_id

delete(**kwargs)

file

The descriptor for the file attribute on the model instance. Return a FieldFile when accessed so you can write code like:

>>> from myapp.models import MyModel
>>> instance = MyModel.objects.get(pk=1)
>>> instance.file.size

Assign a file object on assignment so you can do:

>>> with open('/path/to/hello.world') as f:
...     instance.file = File(f)

property file_name

property frontend_file_url

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property is_image

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

options

Accessor to the related objects manager on the forward and reverse sides of a many-to-many relation.

In the example:

class Pizza(Model):
    toppings = ManyToManyField(Topping, related_name='pizzas')

Pizza.toppings and Topping.pizzas are ManyToManyDescriptor instances.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

orderposition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

orderposition_id

question

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

question_id

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

class eventyay.base.models.Checkin(*args, **kwargs)

Bases: Model

A check-in object is created when a person enters or exits the event.

CHECKIN_TYPES = (('entry', 'Entry'), ('exit', 'Exit'))

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

TYPE_ENTRY = 'entry'

TYPE_EXIT = 'exit'

auto_checked_in: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

datetime: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(**kwargs)

device

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

device_id

forced: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

gate

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

gate_id

get_next_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=True, **kwargs)

get_previous_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=False, **kwargs)

get_type_display(*, field=<django.db.models.fields.CharField: type>)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

list

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

list_id

nonce: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

position

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

position_id

save(**kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

Logging

class eventyay.base.models.LogEntry(*args, **kwargs)

Bases: Model

Represents a change or action that has been performed on another object in the database. This uses django.contrib.contenttypes to allow a relation to an arbitrary database object.

Parameters:

datetime (datetime) – The timestamp of the logged action
user (User) – The user that performed the action
action_type (str) – The type of action that has been performed. This is used to look up the renderer used to describe the action in a human- readable way. This should be some namespaced value using dotted notation to avoid duplicates, e.g. "eventyay.plugins.banktransfer.incoming_transfer".
data (str) – Arbitrary data that can be used by the log action renderer

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

action_type: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

all = <django.db.models.manager.Manager object>

api_token

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

api_token_id

classmethod bulk_postprocess(objects)

content_object

Provide a generic many-to-one relation through the content_type and object_id fields.

This class also doubles as an accessor to the related object (similar to ForwardManyToOneDescriptor) by adding itself as a model attribute.

content_type

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

content_type_id

data: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

datetime: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(using=None, keep_parents=False)

device

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

device_id

display()

display_object

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

get_next_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=True, **kwargs)

get_previous_by_datetime(*, field=<django.db.models.fields.DateTimeField: datetime>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_orga_action: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

json_data

property notification_type

oauth_application

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

oauth_application_id

object_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <eventyay.base.models.log.VisibleOnlyManager object>

organizer

parsed_data

property person

shredded: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property timestamp

user

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

user_id

visible: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property webhook_type

Invoicing

class eventyay.base.models.Invoice(*args, **kwargs)

Bases: Model

Represents an invoice that is issued because of an order. Because invoices are legally required not to change, this object duplicates a lot of data (e.g. the invoice address).

Parameters:

order (Order) – The associated order
event (Event) – The event this belongs to (for convenience)
organizer (Organizer) – The organizer this belongs to (redundant, for enforcing uniqueness)
invoice_no (int) – The human-readable, event-unique invoice number
is_cancellation (bool) – Whether or not this is a cancellation instead of an invoice
refers (Invoice) – A link to another invoice this invoice refers to, e.g. the canceled invoice in a cancellation
invoice_from (str) – The sender address
invoice_to (str) – The receiver address
full_invoice_no (str) – The full invoice number (for performance reasons only)
date (date) – The invoice date
locale (str) – The locale in which the invoice should be printed
introductory_text (str) – Introductory text for the invoice, e.g. for a greeting
additional_text (str) – Additional text for the invoice
payment_provider_text (str) – A payment provider specific text
footer_text (str) – A footer text, displayed smaller and centered on every page
foreign_currency_display (str) – A different currency that taxes should also be displayed in.
foreign_currency_rate (Decimal) – The rate of a foreign currency that the taxes should be displayed in.
foreign_currency_rate_date (date) – The date of the foreign currency exchange rates.
file (File) – The filename of the rendered invoice

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

additional_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property address_invoice_from

property address_invoice_to

canceled

custom_field: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

date: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(*args, **kwargs): Deleting an Invoice would allow for the creation of another Invoice object with the same invoice_no as the deleted one. For various reasons, invoice_no should be reliably unique for an event.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

file

The descriptor for the file attribute on the model instance. Return a FieldFile when accessed so you can write code like:

>>> from myapp.models import MyModel
>>> instance = MyModel.objects.get(pk=1)
>>> instance.file.size

Assign a file object on assignment so you can do:

>>> with open('/path/to/hello.world') as f:
...     instance.file = File(f)

footer_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

foreign_currency_display: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

foreign_currency_rate: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

foreign_currency_rate_date: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property full_invoice_from

full_invoice_no: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_invoice_from_country_display(*, field=<eventyay.helpers.countries.FastCountryField: invoice_from_country>)

get_invoice_to_country_display(*, field=<eventyay.helpers.countries.FastCountryField: invoice_to_country>)

get_next_by_date(*, field=<django.db.models.fields.DateField: date>, is_next=True, **kwargs)

get_previous_by_date(*, field=<django.db.models.fields.DateField: date>, is_next=False, **kwargs)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

internal_reference: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

introductory_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_from: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_from_city: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_from_country

A descriptor for country fields on a model instance. Returns a Country when accessed so you can do things like:

>>> from people import Person
>>> person = Person.object.get(name='Chris')

>>> person.country.name
'New Zealand'

>>> person.country.flag
'/static/flags/nz.gif'

invoice_from_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_from_tax_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_from_vat_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_from_zipcode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_no: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_beneficiary: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_city: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_company: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_country

A descriptor for country fields on a model instance. Returns a Country when accessed so you can do things like:

>>> from people import Person
>>> person = Person.object.get(name='Chris')

>>> person.country.name
'New Zealand'

>>> person.country.flag
'/static/flags/nz.gif'

invoice_to_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_state: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_street: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_vat_id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice_to_zipcode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_cancellation: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

lines

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

locale: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

property number: Returns the invoice number in a human-readable string with the event slug prepended.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

order

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

order_id

organizer

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

organizer_id

payment_provider_text: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

prefix: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

refered

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

refers

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

refers_id

reverse_charge: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

shredded: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class eventyay.base.models.InvoiceLine(*args, **kwargs)

Bases: Model

One position listed on an Invoice.

Parameters:

invoice (Invoice) – The invoice this belongs to
description (str) – The product description
gross_value (decimal.Decimal) – The gross value
tax_value (decimal.Decimal) – The included tax (as an absolute value)
tax_rate (decimal.Decimal) – The applied tax rate in percent
tax_name (str) – The name of the applied tax rate
subevent (SubEvent) – The subevent this line refers to
event_date_from (datetime) – Event date of the (sub)event at the time the invoice was created
event_date_to (datetime) – Event end date of the (sub)event at the time the invoice was created
product (Product) – The product this line refers to
variation (ProductVariation) – The variation this line refers to
attendee_name (str) – The attendee name at the time the invoice was created

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

attendee_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

description: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event_date_from: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

event_date_to: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

gross_value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

invoice

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

invoice_id

property net_value

objects = <django.db.models.manager.Manager object>

position: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

product

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

product_id

subevent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

subevent_id

tax_name: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tax_rate: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

tax_value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

variation

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

variation_id

Vouchers

class eventyay.base.models.Voucher(*args, **kwargs)

Bases: LoggedModel

A Voucher can reserve ticket quota or allow special prices.

Parameters:

event (Event) – The event this voucher is valid for
subevent (SubEvent) – The date in the event series, if event series are enabled
code (str) – The secret voucher code
max_usages (int) – The number of times this voucher can be redeemed
redeemed (int) – The number of times this voucher already has been redeemed
valid_until (datetime) – The expiration date of this voucher (optional)
block_quota (bool) – If set to true, this voucher will reserve quota for its holder
allow_ignore_quota (bool) – If set to true, this voucher can be redeemed even if the event is sold out
price_mode (str) – Sets how this voucher affects a product’s price. Can be none, set, subtract or percent.
value (decimal.Decimal) – The value by which the price should be modified in the way specified by price_mode.
product (Product) – If set, the product to sell
variation (ProductVariation) – If set, the variation to sell
quota (Quota) – If set, the quota to choose an product from
comment (str) – An internal comment that will only be visible to staff, and never displayed to the user
tag (str) – Use this field to group multiple vouchers together. If you enter the same value for multiple vouchers, you can get statistics on how many of them have been redeemed etc.

Various constraints apply:

You need to either select a quota or an product
If you select an product that has variations but do not select a variation, you cannot set block_quota

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

allow_delete()

allow_ignore_quota: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

classmethod annotate_budget_used_orders(qs)

applies_to(product: Product, variation: ProductVariation = None) → bool: returns whether this voucher applies to a given product (and optionally a variation).

block_quota: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

budget: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

budget_used()

calculate_price(original_price: Decimal, max_discount: Decimal = None) → Decimal: Returns how the price given in original_price would be modified if this voucher is applied, i.e. replaced by a different price or reduced by a certain percentage. If the voucher does not modify the price, the original price will be returned.

cartposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

clean(): Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

static clean_max_usages(data, redeemed)

static clean_product_properties(data, event, quota, product, variation, block_quota=False, seats_given=False)

static clean_quota_check(data, cnt, old_instance, event, quota, product, variation)

static clean_quota_get_ignored(old_instance)

static clean_quota_needs_checking(data, old_instance, product_changed, creating)

static clean_seat_id(data, product, quota, event, pk)

static clean_subevent(data, event)

static clean_voucher_code(data, event, pk)

code: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

comment: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

delete(using=None, keep_parents=False)

distinct_orders(): Return the list of orders where this voucher has been used. Each order will appear at most once.

event

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

event_id

get_price_mode_display(*, field=<django.db.models.fields.CharField: price_mode>)

id: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

is_active(): Returns True if a voucher has not yet been redeemed, but is still within its validity (if valid_until is set).

is_in_cart() → bool: Returns whether a cart position exists that uses this voucher.

is_ordered() → bool: Returns whether an order position exists that uses this voucher.

max_usages: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django_scopes.manager.ScopedManager.<locals>.Manager object>

orderposition_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

price_mode: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

product

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

product_id

quota

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

quota_id

redeemed: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

seat

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

seat_id

seating_available(subevent)

show_hidden_products: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

subevent

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

subevent_id

tag: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

valid_until: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

value: A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

variation

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

variation_id

waitinglistentries

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.