Specs

add(map(), String.t(), DateTime.t(), map()) :: Breezex.Client.client_response()

Adds an event to a Breeze calendar.

Name and start_time (as a DateTime struct) are required. Optional details include:

• end_time -- what time the event ends. Default: one hour after start time.
• all_day -- if 1, ignores the time portion of the start_time DateTime. Default: 0.
• description -- description of the event on the calendar. HTML is allowed.
• category_id -- id of the calender it should be put on. Default: 0.
• event_id -- adds the new event to the series belonging to event_id. Default: create new series.

Specs

add!(map(), String.t(), DateTime.t(), map()) :: {map(), list()} | no_return()

Specs

check_in(map(), map()) :: Breezex.Client.client_response()

Check a person into an event.

Shape of params should be %{instance_id: instance_id, person_id: person_id}

Specs

check_in!(map(), map()) :: {map(), list()} | no_return()

Specs

check_out(map(), map()) :: Breezex.Client.client_response()

Check a person out of an event.

Shape of params should be %{instance_id: instance_id, person_id: person_id}

Specs

check_out!(map(), map()) :: {map(), list()} | no_return()

Specs

delete(map(), String.t()) :: Breezex.Client.client_response()

Delete an event using its ID

Specs

delete!(map(), String.t()) :: {map(), list()} | no_return()

Specs

detailed_roster(map(), String.t() | Integer) :: Breezex.Client.client_response()

List detailed info about everyone who attended an event.

Specs

detailed_roster!(map(), String.t() | Integer) :: {map(), list()} | no_return()

Specs

eligible_people(map(), String.t() | Integer) :: Breezex.Client.client_response()

Get a list of people eligible for check-in

Specs

eligible_people!(map(), String.t() | Integer) :: {map(), list()} | no_return()

Specs

headcount(map(), String.t() | Integer) :: Breezex.Client.client_response()

Get an anonymous headcount of event attendance.

Specs

headcount!(map(), String.t() | Integer) :: {map(), list()} | no_return()

Specs

list(map()) :: Breezex.Client.client_response()

List the current month's events

Specs

list(map(), map()) :: Breezex.Client.client_response()

Advanced event search

The query parameter is a map. Available keys:

• start -- events on or after date. Default first of current month.
• end -- events on or before date. Default last of current month.
• category_id -- limit to events on this calendar
• eligible -- if 1, include details about check-in eligibility ("everyone", "tags", "forms", or "none"). Default 0.
• details -- if 1, include event details. Default 0.
• limit -- number of events to return. Default 500. Max 1000.

Specs

list!(map()) :: {map(), list()} | no_return()

Specs

list!(map(), map()) :: {map(), list()} | no_return()

Specs

list_calendars(map()) :: Breezex.Client.client_response()

List all available calendars

Specs

list_calendars!(map()) :: {map(), list()} | no_return()

Specs

list_locations(map()) :: Breezex.Client.client_response()

List all configured locations

Specs

list_locations!(map()) :: {map(), list()} | no_return()

Specs

roster(map(), String.t() | Integer) :: Breezex.Client.client_response()

List basic info about everyone who attended an event.

Specs

roster!(map(), String.t() | Integer) :: {map(), list()} | no_return()

Specs

show(map(), String.t()) :: Breezex.Client.client_response()

Show details for one event instance

Specs

show!(map(), String.t()) :: {map(), list()} | no_return()

Specs

show_series(map(), String.t(), map()) :: Breezex.Client.client_response()

List events associated with instance_id

Params is a map with available keys:

• shedule_direction -- include events before or after (default "before")
• schedule_limit -- how many events to return. Default 10. Max 100.
• eligible -- if 1, include details about check-in eligibility ("everyone", "tags", "forms", or "none"). Default 0.
• details -- if 1, include event details

Specs

show_series!(map(), String.t(), map()) :: {map(), list()} | no_return()

Specs

unrecord(map(), map()) :: Breezex.Client.client_response()

Remove an attendance record.

Shape of params should be %{instance_id: instance_id, person_id: person_id}

Specs

unrecord!(map(), map()) :: {map(), list()} | no_return()