MemberApi

MemberApi ¶

API for managing OrangeTheory member data.

Provides methods to retrieve and update member details, notification settings, membership information, and purchase history.

get_sms_notification_settings()

Get the member's SMS notification settings.

Returns:

Name	Type	Description
`SmsNotificationSettings`	`SmsNotificationSettings`	The member's SMS notification settings.

update_sms_notification_settings(promotional_enabled=None, transactional_enabled=None)

Update the member's SMS notification settings. Arguments not provided will be left unchanged.

Parameters:

Name	Type	Description	Default
`promotional_enabled`	`bool \| None`	Whether to enable promotional SMS notifications.	`None`
`transactional_enabled`	`bool \| None`	Whether to enable transactional SMS notifications.	`None`

Returns:

Name	Type	Description
`SmsNotificationSettings`	`SmsNotificationSettings`	The updated SMS notification settings.

get_email_notification_settings()

Get the member's email notification settings.

Returns:

Name	Type	Description
`EmailNotificationSettings`	`EmailNotificationSettings`	The member's email notification settings.

update_email_notification_settings(promotional_enabled=None, transactional_enabled=None)

Update the member's email notification settings. Arguments not provided will be left unchanged.

Parameters:

Name	Type	Description	Default
`promotional_enabled`	`bool \| None`	Whether to enable promotional email notifications.	`None`
`transactional_enabled`	`bool \| None`	Whether to enable transactional email notifications.	`None`

Returns:

Name	Type	Description
`EmailNotificationSettings`	`EmailNotificationSettings`	The updated email notification settings.

update_member_name(first_name=None, last_name=None)

Update the member's name. Will return the original member details if no names are provided.

Parameters:

Name	Type	Description	Default
`first_name`	`str \| None`	The first name to update to. Default is None.	`None`
`last_name`	`str \| None`	The last name to update to. Default is None.	`None`

Returns:

Name	Type	Description
`MemberDetail`	`MemberDetail`	The updated member details or the original member details if no changes were made.

get_member_detail()

Get the member details.

Returns:

Name	Type	Description
`MemberDetail`	`MemberDetail`	The member details.

get_member_membership()

Get the member's membership details.

Returns:

Name	Type	Description
`MemberMembership`	`MemberMembership`	The member's membership details.

get_member_purchases()

Get the member's purchases, including monthly subscriptions and class packs.

Returns:

Type	Description
`list[MemberPurchase]`	list[MemberPurchase]: The member's purchases.