models package

class f3_data_models.models.User_Status(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the status of a user.

active

inactive

deleted

class f3_data_models.models.Region_Role(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the roles within a region.

user

editor

admin

class f3_data_models.models.User_Role(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the roles of a user.

user

editor

admin

class f3_data_models.models.Update_Request_Status(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the status of an update request.

pending

approved

rejected

class f3_data_models.models.Day_Of_Week(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the days of the week.

class f3_data_models.models.Event_Cadence(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the cadence of an event.

weekly

monthly

class f3_data_models.models.Achievement_Cadence(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the cadence of an achievement.

weekly

monthly

quarterly

yearly

lifetime

class f3_data_models.models.Achievement_Threshold_Type(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the type of threshold for an achievement.

posts

unique_aos

class f3_data_models.models.Org_Type(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the type of organization.

ao

region

area

sector

nation

class f3_data_models.models.Event_Category(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the category of an event.

first_f

second_f

third_f

class f3_data_models.models.Request_Type(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum representing the type of request.

create_location

create_event

edit

delete_event

class f3_data_models.models.Base(**kwargs: Any)

Bases: DeclarativeBase

Base class for all models, providing common methods.

get_id()

Get the primary key of the model.

get()

Get the value of a specified attribute.

to_json()

Convert the model instance to a JSON-serializable dictionary.

__repr__()

Get a string representation of the model instance.

_update()

Update the model instance with the provided fields.

get_id()

Get the primary key of the model.

Returns:

The primary key of the model.

Return type:

int

get(attr)

Get the value of a specified attribute.

Parameters:

attr (str) – The name of the attribute.

Returns:

The value of the attribute if it exists, otherwise None.

Return type:

Any

to_json()

Convert the model instance to a JSON-serializable dictionary.

Returns:

A dictionary representation of the model instance.

Return type:

dict

metadata: ClassVar[MetaData] = MetaData()

Refers to the _schema.MetaData collection that will be used for new _schema.Table objects.

See also

orm_declarative_metadata

registry: ClassVar[_RegistryType] = <sqlalchemy.orm.decl_api.registry object>

Refers to the _orm.registry in use where new _orm.Mapper objects will be associated.

class f3_data_models.models.SlackSpace(**kwargs)

Bases: Base

Model representing a Slack workspace.

id

Primary Key of the model.

Type:

int

team_id

The Slack-internal unique identifier for the Slack team.

Type:

str

workspace_name

The name of the Slack workspace.

Type:

Optional[str]

bot_token

The bot token for the Slack workspace.

Type:

Optional[str]

settings

Slack Bot settings for the Slack workspace.

Type:

Optional[Dict[str, Any]]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.Role(**kwargs)

Bases: Base

Model representing a role. A role is a set of permissions that can be assigned to users.

id

Primary Key of the model.

Type:

int

name

The name of the role.

Type:

Region_Role

description

A description of the role.

Type:

Optional[text]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.Permission(**kwargs)

Bases: Base

Model representing a permission.

id

Primary Key of the model.

Type:

int

name

The name of the permission.

Type:

str

description

A description of the permission.

Type:

Optional[text]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.Role_x_Permission(**kwargs)

Bases: Base

Model representing the assignment of permissions to roles.

role_id

The ID of the associated role.

Type:

int

permission_id

The ID of the associated permission.

Type:

int

class f3_data_models.models.Role_x_User_x_Org(**kwargs)

Bases: Base

Model representing the assignment of roles, users, and organizations.

role_id

The ID of the associated role.

Type:

int

user_id

The ID of the associated user.

Type:

int

org_id

The ID of the associated organization.

Type:

int

class f3_data_models.models.Org(**kwargs)

Bases: Base

Model representing an organization. The same model is used for all levels of organization (AOs, Regions, etc.).

id

Primary Key of the model.

Type:

int

parent_id

The ID of the parent organization.

Type:

Optional[int]

org_type

The type of the organization.

Type:

Org_Type

default_location_id

The ID of the default location.

Type:

Optional[int]

name

The name of the organization.

Type:

str

description

A description of the organization.

Type:

Optional[text]

is_active

Whether the organization is active.

Type:

bool

logo_url

The URL of the organization’s logo.

Type:

Optional[str]

website

The organization’s website.

Type:

Optional[str]

email

The organization’s email.

Type:

Optional[str]

twitter

The organization’s Twitter handle.

Type:

Optional[str]

facebook

The organization’s Facebook page.

Type:

Optional[str]

instagram

The organization’s Instagram handle.

Type:

Optional[str]

last_annual_review

The date of the last annual review.

Type:

Optional[date]

meta

Additional metadata for the organization.

Type:

Optional[Dict[str, Any]]

ao_count

The number of AOs associated with the organization. Defaults to 0, will be updated by triggers.

Type:

int

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

locations

The locations associated with the organization. Probably only relevant for regions.

Type:

Optional[List[Location]]

event_types

The event types associated with the organization. Used to control which event types are available for selection at the region level.

Type:

Optional[List[EventType]]

event_tags

The event tags associated with the organization. Used to control which event tags are available for selection at the region level.

Type:

Optional[List[EventTag]]

achievements

The achievements available within the organization.

Type:

Optional[List[Achievement]]

parent_org

The parent organization.

Type:

Optional[Org]

slack_space

The associated Slack workspace.

Type:

Optional[SlackSpace]

class f3_data_models.models.EventType(**kwargs)

Bases: Base

Model representing an event type. Event types can be shared by regions or not, and should roll up into event categories.

id

Primary Key of the model.

Type:

int

name

The name of the event type.

Type:

str

description

A description of the event type.

Type:

Optional[text]

acronym

Acronyms associated with the event type.

Type:

Optional[str]

event_category

The category of the event type (first_f, second_f, third_f).

Type:

Event_Category

specific_org_id

The ID of the specific organization.

Type:

Optional[int]

is_active

Whether the event type is active. Default is True.

Type:

bool

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.EventType_x_Event(**kwargs)

Bases: Base

Model representing the association between events and event types. The intention is that a single event can be associated with multiple event types.

event_id

The ID of the associated event.

Type:

int

event_type_id

The ID of the associated event type.

Type:

int

event

The associated event.

Type:

Event

class f3_data_models.models.EventType_x_EventInstance(**kwargs)

Bases: Base

Model representing the association between event instances and event types. The intention is that a single event instance can be associated with multiple event types.

event_instance_id

The ID of the associated event instance.

Type:

int

event_type_id

The ID of the associated event type.

Type:

int

event_instance

The associated event instance.

Type:

EventInstance

class f3_data_models.models.EventTag(**kwargs)

Bases: Base

Model representing an event tag. These are used to mark special events, such as anniversaries or special workouts.

id

Primary Key of the model.

Type:

int

name

The name of the event tag.

Type:

str

description

A description of the event tag.

Type:

Optional[text]

color

The color used for the calendar.

Type:

Optional[str]

specific_org_id

Used for custom tags for specific regions.

Type:

Optional[int]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.EventTag_x_Event(**kwargs)

Bases: Base

Model representing the association between event tags and events. The intention is that a single event can be associated with multiple event tags.

event_id

The ID of the associated event.

Type:

int

event_tag_id

The ID of the associated event tag.

Type:

int

event

The associated event.

Type:

Event

class f3_data_models.models.EventTag_x_EventInstance(**kwargs)

Bases: Base

Model representing the association between event tags and event instances. The intention is that a single event instance can be associated with multiple event tags.

event_instance_id

The ID of the associated event instance.

Type:

int

event_tag_id

The ID of the associated event tag.

Type:

int

event_instance

The associated event instance.

Type:

EventInstance

class f3_data_models.models.Org_x_SlackSpace(**kwargs)

Bases: Base

Model representing the association between organizations and Slack workspaces. This is currently meant to be one to one, but theoretically could support multiple workspaces per organization.

org_id

The ID of the associated organization.

Type:

int

slack_space_id

The ID of the associated Slack workspace.

Type:

str

class f3_data_models.models.Location(**kwargs)

Bases: Base

Model representing a location. Locations are expected to belong to a single organization (region).

id

Primary Key of the model.

Type:

int

org_id

The ID of the associated organization.

Type:

int

name

The name of the location.

Type:

str

description

A description of the location.

Type:

Optional[text]

is_active

Whether the location is active.

Type:

bool

email

A contact email address associated with the location.

Type:

Optional[str]

lat

The latitude of the location.

Type:

Optional[float]

lon

The longitude of the location.

Type:

Optional[float]

address_street

The street address of the location.

Type:

Optional[str]

address_city

The city of the location.

Type:

Optional[str]

address_state

The state of the location.

Type:

Optional[str]

address_zip

The ZIP code of the location.

Type:

Optional[str]

address_country

The country of the location.

Type:

Optional[str]

meta

Additional metadata for the location.

Type:

Optional[Dict[str, Any]]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.Event(**kwargs)

Bases: Base

Model representing an event or series; the same model is used for both with a self-referential relationship for series.

id

Primary Key of the model.

Type:

int

org_id

The ID of the associated organization.

Type:

int

location_id

The ID of the associated location.

Type:

Optional[int]

series_id

The ID of the associated event series.

Type:

Optional[int]

is_series

Whether this record is a series or single occurrence. Default is False.

Type:

bool

is_active

Whether the event is active. Default is True.

Type:

bool

highlight

Whether the event is highlighted. Default is False.

Type:

bool

start_date

The start date of the event.

Type:

date

end_date

The end date of the event.

Type:

Optional[date]

start_time

The start time of the event. Format is ‘HHMM’, 24-hour time, timezone naive.

Type:

Optional[str]

end_time

The end time of the event. Format is ‘HHMM’, 24-hour time, timezone naive.

Type:

Optional[str]

day_of_week

The day of the week of the event.

Type:

Optional[Day_Of_Week]

name

The name of the event.

Type:

str

description

A description of the event.

Type:

Optional[text]

email

A contact email address associated with the event.

Type:

Optional[str]

recurrence_pattern

The recurrence pattern of the event. Current options are ‘weekly’ or ‘monthly’.

Type:

Optional[Event_Cadence]

recurrence_interval

The recurrence interval of the event (e.g. every 2 weeks).

Type:

Optional[int]

index_within_interval

The index within the recurrence interval. (e.g. 2nd Tuesday of the month).

Type:

Optional[int]

pax_count

The number of participants.

Type:

Optional[int]

fng_count

The number of first-time participants.

Type:

Optional[int]

meta

Additional metadata for the event.

Type:

Optional[Dict[str, Any]]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

org

The associated organization.

Type:

Org

location

The associated location.

Type:

Location

event_types

The associated event types.

Type:

List[EventType]

event_tags

The associated event tags.

Type:

Optional[List[EventTag]]

event_x_event_types

The association between the event and event types.

Type:

List[EventType_x_Event]

event_x_event_tags

The association between the event and event tags.

Type:

Optional[List[EventTag_x_Event]]

class f3_data_models.models.EventInstance(**kwargs)

Bases: Base

Model representing an event instance (a single occurrence of an event).

id

Primary Key of the model.

Type:

int

org_id

The ID of the associated organization.

Type:

int

location_id

The ID of the associated location.

Type:

Optional[int]

series_id

The ID of the associated event series.

Type:

Optional[int]

is_active

Whether the event is active. Default is True.

Type:

bool

highlight

Whether the event is highlighted. Default is False.

Type:

bool

start_date

The start date of the event.

Type:

date

end_date

The end date of the event.

Type:

Optional[date]

start_time

The start time of the event. Format is ‘HHMM’, 24-hour time, timezone naive.

Type:

Optional[str]

end_time

The end time of the event. Format is ‘HHMM’, 24-hour time, timezone naive.

Type:

Optional[str]

name

The name of the event.

Type:

str

description

A description of the event.

Type:

Optional[text]

email

A contact email address associated with the event.

Type:

Optional[str]

pax_count

The number of participants.

Type:

Optional[int]

fng_count

The number of first-time participants.

Type:

Optional[int]

preblast

The pre-event announcement.

Type:

Optional[text]

backblast

The post-event report.

Type:

Optional[text]

preblast_rich

The rich text pre-event announcement (e.g. Slack message).

Type:

Optional[Dict[str, Any]]

backblast_rich

The rich text post-event report (e.g. Slack message).

Type:

Optional[Dict[str, Any]]

preblast_ts

The Slack post timestamp of the pre-event announcement.

Type:

Optional[float]

backblast_ts

The Slack post timestamp of the post-event report.

Type:

Optional[float]

meta

Additional metadata for the event.

Type:

Optional[Dict[str, Any]]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

org

The associated organization.

Type:

Org

location

The associated location.

Type:

Location

event_types

The associated event types.

Type:

List[EventType]

event_tags

The associated event tags.

Type:

Optional[List[EventTag]]

event_instances_x_event_types

The association between the event and event types.

Type:

List[EventType_x_EventInstance]

event_instances_x_event_tags

The association between the event and event tags.

Type:

Optional[List[EventTag_x_EventInstance]]

class f3_data_models.models.AttendanceType(**kwargs)

Bases: Base

Model representing an attendance type. Basic types are 1=’PAX’, 2=’Q’, 3=’Co-Q’

type

The type of attendance.

Type:

str

description

A description of the attendance type.

Type:

Optional[str]

class f3_data_models.models.Attendance_x_AttendanceType(**kwargs)

Bases: Base

Model representing the association between attendance and attendance types.

attendance_id

The ID of the associated attendance.

Type:

int

attendance_type_id

The ID of the associated attendance type.

Type:

int

attendance

The associated attendance.

Type:

Attendance

class f3_data_models.models.User(**kwargs)

Bases: Base

Model representing a user.

id

Primary Key of the model.

Type:

int

f3_name

The F3 name of the user.

Type:

Optional[str]

first_name

The first name of the user.

Type:

Optional[str]

last_name

The last name of the user.

Type:

Optional[str]

email

The email of the user.

Type:

str

phone

The phone number of the user.

Type:

Optional[str]

home_region_id

The ID of the home region.

Type:

Optional[int]

avatar_url

The URL of the user’s avatar.

Type:

Optional[str]

meta

Additional metadata for the user.

Type:

Optional[Dict[str, Any]]

email_verified

The timestamp when the user’s email was verified.

Type:

Optional[datetime]

status

The status of the user. Default is ‘active’.

Type:

UserStatus

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.SlackUser(**kwargs)

Bases: Base

Model representing a Slack user.

id

Primary Key of the model.

Type:

int

slack_id

The Slack ID of the user.

Type:

str

user_name

The username of the Slack user.

Type:

str

email

The email of the Slack user.

Type:

str

is_admin

Whether the user is an admin.

Type:

bool

is_owner

Whether the user is the owner.

Type:

bool

is_bot

Whether the user is a bot.

Type:

bool

user_id

The ID of the associated user.

Type:

Optional[int]

avatar_url

The URL of the user’s avatar.

Type:

Optional[str]

slack_team_id

The ID of the associated Slack team.

Type:

str

strava_access_token

The Strava access token of the user.

Type:

Optional[str]

strava_refresh_token

The Strava refresh token of the user.

Type:

Optional[str]

strava_expires_at

The expiration time of the Strava token.

Type:

Optional[datetime]

strava_athlete_id

The Strava athlete ID of the user.

Type:

Optional[int]

meta

Additional metadata for the Slack user.

Type:

Optional[Dict[str, Any]]

slack_updated

The last update time of the Slack user.

Type:

Optional[int]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.Attendance(**kwargs)

Bases: Base

Model representing an attendance record.

id

Primary Key of the model.

Type:

int

event_instance_id

The ID of the associated event instance.

Type:

int

user_id

The ID of the associated user.

Type:

Optional[int]

is_planned

Whether this is planned attendance (True) vs actual attendance (False).

Type:

bool

meta

Additional metadata for the attendance.

Type:

Optional[Dict[str, Any]]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

event_instance

The associated event instance.

Type:

EventInstance

user

The associated user.

Type:

User

slack_users

The associated Slack Users for this User (a User can be in multiple SlackSpaces).

Type:

Optional[List[SlackUser]]

attendance_x_attendance_types

The association between the attendance and attendance types.

Type:

List[Attendance_x_AttendanceType]

attendance_types

The associated attendance types.

Type:

List[AttendanceType]

class f3_data_models.models.Achievement(**kwargs)

Bases: Base

Model representing an achievement.

id

Primary Key of the model.

Type:

int

name

The name of the achievement.

Type:

str

description

A description of the achievement.

Type:

Optional[str]

image_url

The URL of the achievement’s image.

Type:

Optional[str]

specific_org_id

The ID of the specific region if a custom achievement. If null, the achievement is available to all regions.

Type:

Optional[int]

is_active

Whether the achievement is active. Default is True.

Type:

bool

auto_award

Whether the achievement is automatically awarded or needs to be manually tagged. Default is False.

Type:

bool

auto_cadence

The cadence for automatic awarding of the achievement.

Type:

Optional[Achievement_Cadence]

auto_threshold

The threshold for automatic awarding of the achievement.

Type:

Optional[int]

auto_threshold_type

The type of threshold for automatic awarding of the achievement (‘posts’, ‘unique_aos’, etc.).

Type:

Optional[Achievement_Threshold_Type]

auto_filters

Event filters for automatic awarding of the achievement. Should be a format like {‘include’: [{‘event_type_id’: [1, 2]}, {‘event_tag_id’: [3]}], ‘exclude’: [{‘event_category’: [‘third_f’]}]}.

Type:

Optional[Dict[str, Any]]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.Achievement_x_User(**kwargs)

Bases: Base

Model representing the association between achievements and users.

achievement_id

The ID of the associated achievement.

Type:

int

user_id

The ID of the associated user.

Type:

int

award_year

The year the achievement was awarded. Default is -1 (used for lifetime achievements).

Type:

int

award_period

The period (ie week, month) the achievement was awarded in. Default is -1 (used for lifetime achievements).

Type:

int

date_awarded

The date the achievement was awarded. Default is the current date.

Type:

date

class f3_data_models.models.Position(**kwargs)

Bases: Base

Model representing a position.

name

The name of the position.

Type:

str

description

A description of the position.

Type:

Optional[str]

org_type

The associated organization type. This is used to limit the positions available to certain types of organizations. If null, the position is available to all organization types.

Type:

Optional[Org_Type]

org_id

The ID of the associated organization. This is used to limit the positions available to certain organizations. If null, the position is available to all organizations.

Type:

Optional[int]

class f3_data_models.models.Position_x_Org_x_User(**kwargs)

Bases: Base

Model representing the association between positions, organizations, and users.

position_id

The ID of the associated position.

Type:

int

org_id

The ID of the associated organization.

Type:

int

user_id

The ID of the associated user.

Type:

int

class f3_data_models.models.Expansion(**kwargs)

Bases: Base

Model representing an expansion.

id

Primary Key of the model.

Type:

int

area

The area of the expansion.

Type:

str

pinned_lat

The pinned latitude of the expansion.

Type:

float

pinned_lon

The pinned longitude of the expansion.

Type:

float

user_lat

The user’s latitude.

Type:

float

user_lon

The user’s longitude.

Type:

float

interested_in_organizing

Whether the user is interested in organizing.

Type:

bool

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.Expansion_x_User(**kwargs)

Bases: Base

Model representing the association between expansions and users.

expansion_id

The ID of the associated expansion.

Type:

int

user_id

The ID of the associated user.

Type:

int

requst_date

The date of the request. Default is the current date.

Type:

date

notes

Additional notes for the association.

Type:

Optional[text]

class f3_data_models.models.NextAuthAccount(**kwargs)

Bases: Base

Model representing an authentication account.

user_id

The ID of the associated user.

Type:

int

type

The type of the account.

Type:

text

provider

The provider of the account.

Type:

text

provider_account_id

The provider account ID.

Type:

text

refresh_token

The refresh token.

Type:

Optional[text]

access_token

The access token.

Type:

Optional[text]

expires_at

The expiration time of the token.

Type:

Optional[datetime]

token_type

The token type.

Type:

Optional[text]

scope

The scope of the token.

Type:

Optional[text]

id_token

The ID token.

Type:

Optional[text]

session_state

The session state.

Type:

Optional[text]

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.NextAuthSession(**kwargs)

Bases: Base

Model representing an authentication session.

session_token

The session token.

Type:

text

user_id

The ID of the associated user.

Type:

int

expires

The expiration time of the session.

Type:

ts_notz

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.NextAuthVerificationToken(**kwargs)

Bases: Base

Model representing an authentication verification token.

identifier

The identifier of the token.

Type:

text

token

The token.

Type:

text

expires

The expiration time of the token.

Type:

ts_notz

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime

class f3_data_models.models.UpdateRequest(**kwargs)

Bases: Base

Model representing an update request.

id

The ID of the update request.

Type:

UUID

token

The token of the update request.

Type:

UUID

region_id

The ID of the associated region.

Type:

int

event_id

The ID of the associated event.

Type:

Optional[int]

event_type_ids

The associated event type IDs.

Type:

Optional[List[int]]

event_tag

The associated event tag.

Type:

Optional[str]

event_series_id

The ID of the associated event series.

Type:

Optional[int]

event_is_series

Whether the event is a series.

Type:

Optional[bool]

event_is_active

Whether the event is active.

Type:

Optional[bool]

event_highlight

Whether the event is highlighted.

Type:

Optional[bool]

event_start_date

The start date of the event.

Type:

Optional[date]

event_end_date

The end date of the event.

Type:

Optional[date]

event_start_time

The start time of the event. Format is ‘HHMM’, 24-hour time, timezone naive.

Type:

Optional[str]

event_end_time

The end time of the event. Format is ‘HHMM’, 24-hour time, timezone naive.

Type:

Optional[str]

event_day_of_week

The day of the week of the event.

Type:

Optional[Day_Of_Week]

event_name

The name of the event.

Type:

str

event_description

A description of the event.

Type:

Optional[text]

event_recurrence_pattern

The recurrence pattern of the event.

Type:

Optional[Event_Cadence]

event_recurrence_interval

The recurrence interval of the event.

Type:

Optional[int]

event_index_within_interval

The index within the recurrence interval.

Type:

Optional[int]

event_meta

Additional metadata for the event.

Type:

Optional[Dict[str, Any]]

event_contact_email

The contact email of the event.

Type:

Optional[str]

location_name

The name of the location.

Type:

Optional[text]

location_description

A description of the location.

Type:

Optional[text]

location_address

The address of the location.

Type:

Optional[text]

location_address2

The second address line of the location.

Type:

Optional[text]

location_city

The city of the location.

Type:

Optional[text]

location_state

The state of the location.

Type:

Optional[str]

location_zip

The ZIP code of the location.

Type:

Optional[str]

location_country

The country of the location.

Type:

Optional[str]

location_lat

The latitude of the location.

Type:

Optional[float]

location_lng

The longitude of the location.

Type:

Optional[float]

location_id

The ID of the location.

Type:

Optional[int]

location_contact_email

The contact email of the location.

Type:

Optional[str]

ao_id

The ID of the associated AO.

Type:

Optional[int]

ao_name

The name of the AO.

Type:

Optional[text]

ao_logo

The URL of the AO logo.

Type:

Optional[text]

ao_website

The website of the AO.

Type:

Optional[text]

submitted_by

The user who submitted the request.

Type:

str

submitter_validated

Whether the submitter has validated the request. Default is False.

Type:

Optional[bool]

reviewed_by

The user who reviewed the request.

Type:

Optional[str]

reviewed_at

The timestamp when the request was reviewed.

Type:

Optional[datetime]

status

The status of the request. Default is ‘pending’.

Type:

Update_Request_Status

meta

Additional metadata for the request.

Type:

Optional[Dict[str, Any]]

request_type

The type of the request.

Type:

Request_Type

created

The timestamp when the record was created.

Type:

datetime

updated

The timestamp when the record was last updated.

Type:

datetime