EventbriteClient
Attributes
GetEventsForOrganizationResponse
module-attribute
TRIGGER_OPERATIONS
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewEventV2': {'operation_id': 'OnNewEventV2', 'path': '/{connectionId}/v2/trigger/v3/organizations/{organization_id}/events/', 'method': 'get', 'required_parameters': ['organization_id', 'organizer_filter'], 'callback_payload_type': 'GetEventsForOrganizationResponse'}, 'OnOrderChangedV2': {'operation_id': 'OnOrderChangedV2', 'path': '/{connectionId}/v2/trigger/v3/events/{id}/orders/', 'method': 'get', 'required_parameters': ['organization_id', 'id'], 'callback_payload_type': 'GetOrdersResponse'}}
Classes
CreateEventResponse
dataclass
CreateEventResponse(*, name: Optional[Dict[str, Any]] = None, description: Optional[Dict[str, Any]] = None, id: Optional[str] = None, url: Optional[str] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, created: Optional[str] = None, changed: Optional[str] = None, capacity: Optional[int] = None, online_event: Optional[bool] = None, organizer_id: Optional[str] = None, venue_id: Optional[str] = None, category_id: Optional[str] = None)
Response for Create event
Attributes
id
class-attribute
instance-attribute
The id of the event.
url
class-attribute
instance-attribute
The URL of the event.
created
class-attribute
instance-attribute
The date-time the event was created at.
changed
class-attribute
instance-attribute
The date-time the event was changed at.
capacity
class-attribute
instance-attribute
The capacity of the event.
online_event
class-attribute
instance-attribute
A boolean indicating whether or not the event is online.
organizer_id
class-attribute
instance-attribute
The id of the organizer of the event.
venue_id
class-attribute
instance-attribute
The id of the venue of the event.
GetOrganizersResponse
dataclass
Response for Get organizers
GetMyVenuesResponse
dataclass
Response for Get venues
GetCategoriesResponse
dataclass
Response for Get categories
GetMyEventsResponse
dataclass
Response for Get organization events
EventbriteClient
EventbriteClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for eventbrite connector.
Initialize a EventbriteClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
create_event
async
create_event(organization_id: str, event_name_html: str, event_description_html: str, event_start_utc: str, event_end_utc: str, event_start_timezone: str, event_end_timezone: str, event_currency: str, *, event_organizer_id: Optional[str] = None, event_venue_id: Optional[str] = None, event_category_id: Optional[str] = None, event_password: Optional[str] = None, event_capacity: Optional[str] = None, event_shareable: Optional[bool] = None, event_invite_only: Optional[bool] = None, event_online_event: Optional[bool] = None, event_listed: Optional[bool] = None, event_hide_start_date: Optional[bool] = None, event_hide_end_date: Optional[bool] = None, event_show_remaining: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create event
Create a new Eventbrite event.
Swagger operation ID: CreateEventV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id
|
str
|
Select the organization. |
required |
event_name_html
|
str
|
The name of the event. |
required |
event_description_html
|
str
|
The description on the event page. |
required |
event_start_utc
|
str
|
Start time (UTC format Ex. 2020-01-12T12:00:00Z). |
required |
event_end_utc
|
str
|
End time (UTC format Ex. 2020-01-13T15:00:00Z). |
required |
event_start_timezone
|
str
|
Timezone of the event. |
required |
event_end_timezone
|
str
|
Timezone of the event. |
required |
event_currency
|
str
|
Currency for this Event's transactions. |
required |
event_organizer_id
|
Optional[str]
|
The organizer of the event. |
None
|
event_venue_id
|
Optional[str]
|
A previously-created venue to associate with this event. |
None
|
event_category_id
|
Optional[str]
|
The category of the event. |
None
|
event_password
|
Optional[str]
|
Password needed to see the event in unlisted mode. |
None
|
event_capacity
|
Optional[str]
|
Set specific capacity (if omitted, sums ticket capacities). |
None
|
event_shareable
|
Optional[bool]
|
If users can share the event on social media. |
None
|
event_invite_only
|
Optional[bool]
|
Only invited users can see the event page. |
None
|
event_online_event
|
Optional[bool]
|
Whether the event is online-only (no venue). |
None
|
event_listed
|
Optional[bool]
|
If the event is publicly listed and searchable. |
None
|
event_hide_start_date
|
Optional[bool]
|
Whether the start date should be hidden. |
None
|
event_hide_end_date
|
Optional[bool]
|
Whether the end date should be hidden. |
None
|
event_show_remaining
|
Optional[bool]
|
If the remaining number of tickets is publicly visible on the event page. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_event
async
update_event(id: str, organization_id: str, event_start_timezone: str, event_end_timezone: str, event_currency: str, *, event_name_html: Optional[str] = None, event_description_html: Optional[str] = None, event_start_utc: Optional[str] = None, event_end_utc: Optional[str] = None, event_organizer_id: Optional[str] = None, event_venue_id: Optional[str] = None, event_category_id: Optional[str] = None, event_password: Optional[str] = None, event_capacity: Optional[str] = None, event_shareable: Optional[bool] = None, event_invite_only: Optional[bool] = None, event_online_event: Optional[bool] = None, event_listed: Optional[bool] = None, event_hide_start_date: Optional[bool] = None, event_hide_end_date: Optional[bool] = None, event_show_remaining: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update event
Update an existing event.
Swagger operation ID: UpdateEventV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
Event to update. |
required |
organization_id
|
str
|
Select the organization. |
required |
event_start_timezone
|
str
|
Timezone of the event. |
required |
event_end_timezone
|
str
|
Timezone of the event. |
required |
event_currency
|
str
|
Currency for this Event's transactions. |
required |
event_name_html
|
Optional[str]
|
The name of the event. |
None
|
event_description_html
|
Optional[str]
|
The description on the event page. |
None
|
event_start_utc
|
Optional[str]
|
Start time (UTC format Ex. 2017-01-12T13:45:30Z). |
None
|
event_end_utc
|
Optional[str]
|
End time (UTC format Ex. 2017-01-12T16:45:30Z). |
None
|
event_organizer_id
|
Optional[str]
|
The organizer of the event. |
None
|
event_venue_id
|
Optional[str]
|
A previously-created venue to associate with this event. |
None
|
event_category_id
|
Optional[str]
|
The category of the event. |
None
|
event_password
|
Optional[str]
|
Password needed to see the event in unlisted mode. |
None
|
event_capacity
|
Optional[str]
|
Set specific capacity (if omitted, sums ticket capacities). |
None
|
event_shareable
|
Optional[bool]
|
Set specific capacity (if omitted, sums ticket capacities). |
None
|
event_invite_only
|
Optional[bool]
|
Only invited users can see the event page. |
None
|
event_online_event
|
Optional[bool]
|
Whether the event is online-only (no venue). |
None
|
event_listed
|
Optional[bool]
|
If the event is publicly listed and searchable. |
None
|
event_hide_start_date
|
Optional[bool]
|
Whether the start date should be hidden. |
None
|
event_hide_end_date
|
Optional[bool]
|
Whether the start date should be hidden. |
None
|
event_show_remaining
|
Optional[bool]
|
If the remaining number of tickets is publicly visible on the event page. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_organizations
list_organizations(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
GetOrganizations
Get a list of organizations for your account.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetOrganizations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_organizers
list_organizers(organization_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get organizers
Get a list of organizers for organization.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetOrganizersV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id
|
str
|
Select the organization. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_my_venues
list_my_venues(organization_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get venues
Get venues for organization.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetMyVenuesV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id
|
str
|
Select the organization. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_categories
list_categories(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get categories
Get the Eventbrite event categories.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetCategories.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_organization_events
list_organization_events(organization_id: str, order_by: str, status: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get organization events
Get organization events.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetOrganizationEvents.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id
|
str
|
Select the organization. |
required |
order_by
|
str
|
Order of the returned events. |
required |
status
|
str
|
Status of the returned events. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |